[gimp] devel-docs: Add a urlmap file



commit 175dab9f8630ebb80e9d1a21fa8ca98772f0d88c
Author: Niels De Graef <nielsdegraef gmail com>
Date:   Tue Jun 7 09:42:35 2022 +0200

    devel-docs: Add a urlmap file
    
    The urlmap file allows gi-docgen to generate links for namespaces that
    are also generated by gi-docgen. For example, with this commit, a
    reference to `GObject` will now be properly linked to the GObject
    documentation.

 devel-docs/reference/gimp-ui/gimp-ui-3.0.toml.in | 1 +
 devel-docs/reference/gimp-ui/urlmap.js           | 9 +++++++++
 devel-docs/reference/gimp/gimp-3.0.toml.in       | 1 +
 devel-docs/reference/gimp/urlmap.js              | 9 +++++++++
 4 files changed, 20 insertions(+)
---
diff --git a/devel-docs/reference/gimp-ui/gimp-ui-3.0.toml.in 
b/devel-docs/reference/gimp-ui/gimp-ui-3.0.toml.in
index 69a315bacd..ec8ff1ca1f 100644
--- a/devel-docs/reference/gimp-ui/gimp-ui-3.0.toml.in
+++ b/devel-docs/reference/gimp-ui/gimp-ui-3.0.toml.in
@@ -106,3 +106,4 @@ content_images = [
   'images/string-combo-box.png',
   'images/unit-combo-box.png',
 ]
+urlmap_file = "urlmap.js"
diff --git a/devel-docs/reference/gimp-ui/urlmap.js b/devel-docs/reference/gimp-ui/urlmap.js
new file mode 100644
index 0000000000..912da71647
--- /dev/null
+++ b/devel-docs/reference/gimp-ui/urlmap.js
@@ -0,0 +1,9 @@
+// A map between namespaces and base URLs for their online gi-docgen documentation
+baseURLs = [
+  [ 'GLib', 'https://docs.gtk.org/glib/' ],
+  [ 'GObject', 'https://docs.gtk.org/gobject/' ],
+  [ 'Gdk', 'https://docs.gtk.org/gdk3/' ],
+  [ 'GdkPixbuf', 'https://docs.gtk.org/gdk-pixbuf/' ],
+  [ 'Gio', 'https://docs.gtk.org/gio/' ],
+  [ 'Gtk', 'https://docs.gtk.org/gtk3/' ],
+]
diff --git a/devel-docs/reference/gimp/gimp-3.0.toml.in b/devel-docs/reference/gimp/gimp-3.0.toml.in
index f25364c830..30fa54e6fd 100644
--- a/devel-docs/reference/gimp/gimp-3.0.toml.in
+++ b/devel-docs/reference/gimp/gimp-3.0.toml.in
@@ -72,3 +72,4 @@ base_url = "https://gitlab.gnome.org/GNOME/gimp/-/blob/master/";
 [extra]
 content_files = [
 ]
+urlmap_file = "urlmap.js"
diff --git a/devel-docs/reference/gimp/urlmap.js b/devel-docs/reference/gimp/urlmap.js
new file mode 100644
index 0000000000..912da71647
--- /dev/null
+++ b/devel-docs/reference/gimp/urlmap.js
@@ -0,0 +1,9 @@
+// A map between namespaces and base URLs for their online gi-docgen documentation
+baseURLs = [
+  [ 'GLib', 'https://docs.gtk.org/glib/' ],
+  [ 'GObject', 'https://docs.gtk.org/gobject/' ],
+  [ 'Gdk', 'https://docs.gtk.org/gdk3/' ],
+  [ 'GdkPixbuf', 'https://docs.gtk.org/gdk-pixbuf/' ],
+  [ 'Gio', 'https://docs.gtk.org/gio/' ],
+  [ 'Gtk', 'https://docs.gtk.org/gtk3/' ],
+]


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