glib/docs/reference/gio
Philip Withnall 548ec9f186 docs: Reduce nesting of documentation directories
The `gi-docgen` tool is not designed to be used like that. In
particular, when nesting documentation directories, the generated
`*.devhelp2` files (needed by Devhelp to show the documentation) are
nested one directory level too deep for Devhelp to find them, and hence
are useless, and the documentation doesn’t show up in this common
documentation viewer.

So, change the installed documentation directory hierarchy:
 * `${PREFIX}/share/doc/glib-2.0/gio` → `${PREFIX}/share/doc/gio-2.0`
 * `${PREFIX}/share/doc/glib-2.0/glib-unix` →
   `${PREFIX}/share/doc/glib-unix-2.0`
 * `${PREFIX}/share/doc/glib-2.0/gobject` →
   `${PREFIX}/share/doc/gobject-2.0`
 * etc.
 * `${PREFIX}/share/doc/glib-2.0/glib` → `${PREFIX}/share/doc/glib-2.0`

This is going to seem like pointless churn (the contents of the
documentation have not changed), and packagers may mourn the split of
content in `/usr/share/doc` from `/usr/share/doc/${package_name}` to
`/usr/share/doc/${pkg_config_id}` instead, but that seems to be the best
approach to fix this issue in GLib. gi-docgen’s behaviour does feel
fairly consistent and correct with the rest of how it works (single
output directory).

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Fixes: #3287
2024-03-13 18:51:21 +00:00
..
dbus-error.md docs: Move the GDBusError SECTION 2023-11-14 14:32:19 +00:00
dbus-introspection.md docs: Move the GDBusIntrospection SECTION 2023-11-14 14:32:19 +00:00
dbus-name-owning.md docs: Move the GDBus name owning SECTION 2023-11-14 14:32:19 +00:00
dbus-name-watching.md docs: Move the GDBus name watching SECTION 2023-11-14 14:32:19 +00:00
dbus-utils.md docs: Move the dbusutils SECTION 2023-11-14 14:32:19 +00:00
error.md docs: Move the GIOError SECTION 2023-11-14 14:32:19 +00:00
file-attributes.md docs: Move the GFileAttribute SECTION to Markdown 2023-10-23 13:43:27 +01:00
gapplication.rst docs: Port the man pages from DocBook to reStructuredText 2023-12-21 13:34:48 +00:00
gdbus-codegen.rst gdbus-codegen(1): Suggest --pragma-once for headers written to stdout 2024-02-06 14:06:51 +00:00
gdbus.rst docs: Port the man pages from DocBook to reStructuredText 2023-12-21 13:34:48 +00:00
gio-querymodules.rst docs: Port the man pages from DocBook to reStructuredText 2023-12-21 13:34:48 +00:00
gio-unix.toml.in docs: Split out platform specific GIO and GLib documentation 2024-02-12 17:54:10 +00:00
gio-win32.toml.in docs: Split out platform specific GIO and GLib documentation 2024-02-12 17:54:10 +00:00
gio.rst docs: Port the man pages from DocBook to reStructuredText 2023-12-21 13:34:48 +00:00
gio.toml.in docs: Split out platform specific GIO and GLib documentation 2024-02-12 17:54:10 +00:00
glib-compile-resources.rst docs: Port the man pages from DocBook to reStructuredText 2023-12-21 13:34:48 +00:00
glib-compile-schemas.rst docs: Port the man pages from DocBook to reStructuredText 2023-12-21 13:34:48 +00:00
gresource.rst docs: Port the man pages from DocBook to reStructuredText 2023-12-21 13:34:48 +00:00
gsettings.rst docs: Port the man pages from DocBook to reStructuredText 2023-12-21 13:34:48 +00:00
gvfs-overview.odg update the overview image of the gio docs 2009-06-08 17:29:22 +02:00
gvfs-overview.png update the overview image of the gio docs 2009-06-08 17:29:22 +02:00
io-scheduler.md docs: Move the GIOScheduler SECTION 2023-11-15 11:48:23 +00:00
menu-example.png Add GMenuModel 2011-12-08 18:05:12 -05:00
menu-exporter.md docs: Move the gmenumodel SECTION 2023-11-15 11:48:23 +00:00
menu-model.png Add GMenuModel 2011-12-08 18:05:12 -05:00
meson.build docs: Reduce nesting of documentation directories 2024-03-13 18:51:21 +00:00
migrating-gconf.md docs: Move migrating-gconf.xml to Markdown 2023-10-11 14:01:29 +01:00
migrating-gdbus.md docs: Move migrating-gdbus.xml to Markdown 2023-10-11 14:01:29 +01:00
migrating-gnome-vfs.md docs: Move migrating-gnome-vfs.xml to Markdown 2023-10-11 14:01:29 +01:00
migrating-posix.md docs: Split out platform specific GIO and GLib documentation 2024-02-12 17:54:10 +00:00
networking.md docs: Move the gnetworking SECTION 2023-11-15 11:48:23 +00:00
overview.md docs: Mention GioUnix-2.0 GIR namespace alongside gio-unix-2.0.pc 2024-02-12 17:54:10 +00:00
pollable-utils.md docs: Move the gpollableutils SECTION 2023-11-15 11:48:23 +00:00
tls-overview.md docs: Move the gtls SECTION 2023-11-02 16:30:23 +00:00
unix-mounts.md introspection: Drop Unix and Win32 prefixes from platform specific APIs 2024-02-12 17:54:36 +00:00