From a807604ef67cffbf6f4d84324cd0b2d5e4e94c2d Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Fri, 5 Jul 2024 19:59:10 +0100 Subject: [PATCH] docs: Add source location URL If the base URL for source location is set, gi-docgen will automatically generate a link to the location of declarations and doc blocks in the source. --- docs/reference/gio/gio-unix.toml.in | 3 +++ docs/reference/gio/gio-win32.toml.in | 3 +++ docs/reference/gio/gio.toml.in | 3 +++ docs/reference/girepository/girepository.toml.in | 3 +++ docs/reference/glib/glib-unix.toml.in | 3 +++ docs/reference/glib/glib-win32.toml.in | 3 +++ docs/reference/glib/glib.toml.in | 3 +++ docs/reference/gobject/gobject.toml.in | 3 +++ 8 files changed, 24 insertions(+) diff --git a/docs/reference/gio/gio-unix.toml.in b/docs/reference/gio/gio-unix.toml.in index 3a9deb3bd..a411aa50d 100644 --- a/docs/reference/gio/gio-unix.toml.in +++ b/docs/reference/gio/gio-unix.toml.in @@ -41,6 +41,9 @@ name = "basic" show_index_summary = true show_class_hierarchy = true +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/glib/-/blob/main/" + [extra] urlmap_file = "../urlmap.js" # The same order will be used when generating the index diff --git a/docs/reference/gio/gio-win32.toml.in b/docs/reference/gio/gio-win32.toml.in index 84e75ce7c..f43c3ac6c 100644 --- a/docs/reference/gio/gio-win32.toml.in +++ b/docs/reference/gio/gio-win32.toml.in @@ -41,6 +41,9 @@ name = "basic" show_index_summary = true show_class_hierarchy = true +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/glib/-/blob/main/" + [extra] urlmap_file = "../urlmap.js" # The same order will be used when generating the index diff --git a/docs/reference/gio/gio.toml.in b/docs/reference/gio/gio.toml.in index cd62a1691..f81439671 100644 --- a/docs/reference/gio/gio.toml.in +++ b/docs/reference/gio/gio.toml.in @@ -36,6 +36,9 @@ name = "basic" show_index_summary = true show_class_hierarchy = true +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/glib/-/blob/main/" + [extra] urlmap_file = "../urlmap.js" # The same order will be used when generating the index diff --git a/docs/reference/girepository/girepository.toml.in b/docs/reference/girepository/girepository.toml.in index 4c16c11d2..c4d09808d 100644 --- a/docs/reference/girepository/girepository.toml.in +++ b/docs/reference/girepository/girepository.toml.in @@ -41,6 +41,9 @@ name = "basic" show_index_summary = true show_class_hierarchy = true +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/glib/-/blob/main/" + [extra] urlmap_file = "../urlmap.js" # The same order will be used when generating the index diff --git a/docs/reference/glib/glib-unix.toml.in b/docs/reference/glib/glib-unix.toml.in index 9280c1a34..2a3c36b78 100644 --- a/docs/reference/glib/glib-unix.toml.in +++ b/docs/reference/glib/glib-unix.toml.in @@ -42,6 +42,9 @@ name = "basic" show_index_summary = true show_class_hierarchy = true +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/glib/-/blob/main/" + [extra] urlmap_file = "../urlmap.js" # The same order will be used when generating the index diff --git a/docs/reference/glib/glib-win32.toml.in b/docs/reference/glib/glib-win32.toml.in index a9f624f99..62a6127fb 100644 --- a/docs/reference/glib/glib-win32.toml.in +++ b/docs/reference/glib/glib-win32.toml.in @@ -42,6 +42,9 @@ name = "basic" show_index_summary = true show_class_hierarchy = true +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/glib/-/blob/main/" + [extra] urlmap_file = "../urlmap.js" # The same order will be used when generating the index diff --git a/docs/reference/glib/glib.toml.in b/docs/reference/glib/glib.toml.in index 83acea5c4..31ee7893a 100644 --- a/docs/reference/glib/glib.toml.in +++ b/docs/reference/glib/glib.toml.in @@ -36,6 +36,9 @@ name = "basic" show_index_summary = true show_class_hierarchy = true +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/glib/-/blob/main/" + [extra] urlmap_file = "../urlmap.js" # The same order will be used when generating the index diff --git a/docs/reference/gobject/gobject.toml.in b/docs/reference/gobject/gobject.toml.in index 8c2667244..ac17577d0 100644 --- a/docs/reference/gobject/gobject.toml.in +++ b/docs/reference/gobject/gobject.toml.in @@ -38,6 +38,9 @@ name = "basic" show_index_summary = true show_class_hierarchy = true +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/glib/-/blob/main/" + [extra] urlmap_file = "../urlmap.js" # The same order will be used when generating the index