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.
This commit is contained in:
Niels De Graef 2022-06-07 09:42:35 +02:00
parent 1dded62f6d
commit 175dab9f86
4 changed files with 20 additions and 0 deletions

View file

@ -106,3 +106,4 @@ content_images = [
'images/string-combo-box.png', 'images/string-combo-box.png',
'images/unit-combo-box.png', 'images/unit-combo-box.png',
] ]
urlmap_file = "urlmap.js"

View file

@ -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/' ],
]

View file

@ -72,3 +72,4 @@ base_url = "https://gitlab.gnome.org/GNOME/gimp/-/blob/master/"
[extra] [extra]
content_files = [ content_files = [
] ]
urlmap_file = "urlmap.js"

View file

@ -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/' ],
]