diff options
| author | Niels De Graef <nielsdegraef@gmail.com> | 2022-06-06 17:26:40 +0200 |
|---|---|---|
| committer | Niels De Graef <nielsdegraef@gmail.com> | 2022-06-06 17:26:40 +0200 |
| commit | 6f7e3eeb79c8c87095dddf522e8ebcd976b33392 (patch) | |
| tree | ea34481e534b85d2093d84a3559b6f6309d9d421 /docs | |
| parent | 06616811a544de2e7941ee66d1e182575e32ff1e (diff) | |
| download | gcr-6f7e3eeb79c8c87095dddf522e8ebcd976b33392.tar.gz | |
docs: Add a urlmap file
That allows gi-docgen to link types like `GObject` back to the original
documentation.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/gck/gck.toml.in | 1 | ||||
| -rw-r--r-- | docs/gck/urlmap.js | 6 | ||||
| -rw-r--r-- | docs/gcr-gtk3/gcr-gtk3.toml.in | 1 | ||||
| -rw-r--r-- | docs/gcr-gtk3/urlmap.js | 6 | ||||
| -rw-r--r-- | docs/gcr-gtk4/gcr-gtk4.toml.in | 1 | ||||
| -rw-r--r-- | docs/gcr-gtk4/urlmap.js | 6 | ||||
| -rw-r--r-- | docs/gcr/gcr.toml.in | 1 | ||||
| -rw-r--r-- | docs/gcr/urlmap.js | 6 |
8 files changed, 28 insertions, 0 deletions
diff --git a/docs/gck/gck.toml.in b/docs/gck/gck.toml.in index 696b940..a95826c 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 0000000..6946c20 --- /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 6f5f4da..0c17d69 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 0000000..6946c20 --- /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 a42e5fb..927ee38 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 0000000..6946c20 --- /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 1b89810..e6bc326 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 0000000..6946c20 --- /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/' ], +] |