[gcr] docs: Add a urlmap file



commit 6f7e3eeb79c8c87095dddf522e8ebcd976b33392
Author: Niels De Graef <nielsdegraef gmail com>
Date:   Mon Jun 6 17:26:40 2022 +0200

    docs: Add a urlmap file
    
    That allows gi-docgen to link types like `GObject` back to the original
    documentation.

 docs/gck/gck.toml.in           | 1 +
 docs/gck/urlmap.js             | 6 ++++++
 docs/gcr-gtk3/gcr-gtk3.toml.in | 1 +
 docs/gcr-gtk3/urlmap.js        | 6 ++++++
 docs/gcr-gtk4/gcr-gtk4.toml.in | 1 +
 docs/gcr-gtk4/urlmap.js        | 6 ++++++
 docs/gcr/gcr.toml.in           | 1 +
 docs/gcr/urlmap.js             | 6 ++++++
 8 files changed, 28 insertions(+)
---
diff --git a/docs/gck/gck.toml.in b/docs/gck/gck.toml.in
index 696b9401..a95826cf 100644
--- a/docs/gck/gck.toml.in
+++ b/docs/gck/gck.toml.in
@@ -32,3 +32,4 @@ base_url = "https://gitlab.gnome.org/GNOME/gcr/-/blob/master/";
 content_files = [
   'pkcs11-links.md',
 ]
+urlmap_file = "urlmap.js"
diff --git a/docs/gck/urlmap.js b/docs/gck/urlmap.js
new file mode 100644
index 00000000..6946c209
--- /dev/null
+++ b/docs/gck/urlmap.js
@@ -0,0 +1,6 @@
+// A map between namespaces and base URLs for their online documentation
+baseURLs = [
+  [ 'GLib', 'https://docs.gtk.org/glib/' ],
+  [ 'GObject', 'https://docs.gtk.org/gobject/' ],
+  [ 'Gio', 'https://docs.gtk.org/gio/' ],
+]
diff --git a/docs/gcr-gtk3/gcr-gtk3.toml.in b/docs/gcr-gtk3/gcr-gtk3.toml.in
index 6f5f4dab..0c17d695 100644
--- a/docs/gcr-gtk3/gcr-gtk3.toml.in
+++ b/docs/gcr-gtk3/gcr-gtk3.toml.in
@@ -56,3 +56,4 @@ content_images = [
   'images/tree-selector.png',
   'images/viewer-widget.png',
 ]
+urlmap_file = "urlmap.js"
diff --git a/docs/gcr-gtk3/urlmap.js b/docs/gcr-gtk3/urlmap.js
new file mode 100644
index 00000000..6946c209
--- /dev/null
+++ b/docs/gcr-gtk3/urlmap.js
@@ -0,0 +1,6 @@
+// A map between namespaces and base URLs for their online documentation
+baseURLs = [
+  [ 'GLib', 'https://docs.gtk.org/glib/' ],
+  [ 'GObject', 'https://docs.gtk.org/gobject/' ],
+  [ 'Gio', 'https://docs.gtk.org/gio/' ],
+]
diff --git a/docs/gcr-gtk4/gcr-gtk4.toml.in b/docs/gcr-gtk4/gcr-gtk4.toml.in
index a42e5fbc..927ee38d 100644
--- a/docs/gcr-gtk4/gcr-gtk4.toml.in
+++ b/docs/gcr-gtk4/gcr-gtk4.toml.in
@@ -42,3 +42,4 @@ show_class_hierarchy = true
 
 [source-location]
 base_url = "https://gitlab.gnome.org/GNOME/gcr/-/blob/master/";
+urlmap_file = "urlmap.js"
diff --git a/docs/gcr-gtk4/urlmap.js b/docs/gcr-gtk4/urlmap.js
new file mode 100644
index 00000000..6946c209
--- /dev/null
+++ b/docs/gcr-gtk4/urlmap.js
@@ -0,0 +1,6 @@
+// A map between namespaces and base URLs for their online documentation
+baseURLs = [
+  [ 'GLib', 'https://docs.gtk.org/glib/' ],
+  [ 'GObject', 'https://docs.gtk.org/gobject/' ],
+  [ 'Gio', 'https://docs.gtk.org/gio/' ],
+]
diff --git a/docs/gcr/gcr.toml.in b/docs/gcr/gcr.toml.in
index 1b89810f..e6bc3264 100644
--- a/docs/gcr/gcr.toml.in
+++ b/docs/gcr/gcr.toml.in
@@ -39,3 +39,4 @@ content_files = [
   'pkcs11-configuration.md',
   'trust-store.md',
 ]
+urlmap_file = "urlmap.js"
diff --git a/docs/gcr/urlmap.js b/docs/gcr/urlmap.js
new file mode 100644
index 00000000..6946c209
--- /dev/null
+++ b/docs/gcr/urlmap.js
@@ -0,0 +1,6 @@
+// A map between namespaces and base URLs for their online documentation
+baseURLs = [
+  [ 'GLib', 'https://docs.gtk.org/glib/' ],
+  [ 'GObject', 'https://docs.gtk.org/gobject/' ],
+  [ 'Gio', 'https://docs.gtk.org/gio/' ],
+]


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]