docs: Hide Unix and Win32 symbols from main GLib and GIO docs

These symbols are documented in the {glib,gio}-{unix,win32}
documentation builds, and shouldn’t be duplicated in the main
documentation. It’s a historical (and unavoidable) accident that those
symbols are in the main GIR files.

If we don’t hide the symbols from the main docs build, we now run into
the problem of the `GioUnix` namespace not being known to gi-docgen
while building the `Gio` docs. This is because of the previous two
commits, which ported more of the `gunixmounts` documentation to
gi-docgen syntax. I don’t know of another way to fix this, other than to
hide the `GioUnix` symbols from the `Gio` docs build.

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

Helps: #3250
This commit is contained in:
Philip Withnall 2024-12-20 15:13:16 +00:00
parent 46160f9aad
commit 2ebd1c8f15
No known key found for this signature in database
GPG Key ID: C5C42CFB268637CA
2 changed files with 70 additions and 0 deletions

View File

@ -73,3 +73,38 @@ content_images = [
"menu-model-dark.svg",
"menu-model-light.svg",
]
# We have to hide the GioUnix and GioWin32 symbols from the documentation — they
# have to be present in the GIR files (until we next break API), but their
# documentation is split out to gio-{unix,win32}.toml.
[[object]]
pattern = "Unix[A-Z].+"
hidden = true
[[object]]
pattern = "unix_.+"
hidden = true
[[struct]]
pattern = "Unix[A-Z].+"
hidden = true
[[function]]
pattern = "unix_.+"
hidden = true
[[object]]
pattern = "Win32[A-Z].+"
hidden = true
[[object]]
pattern = "win32_.+"
hidden = true
[[struct]]
pattern = "Win32[A-Z].+"
hidden = true
[[function]]
pattern = "win32_.+"
hidden = true

View File

@ -128,3 +128,38 @@ hidden = true
[[object]]
pattern = "macro__has_*"
hidden = true
# We have to hide the GioUnix and GioWin32 symbols from the documentation — they
# have to be present in the GIR files (until we next break API), but their
# documentation is split out to glib-{unix,win32}.toml.
[[object]]
pattern = "Unix[A-Z].+"
hidden = true
[[object]]
pattern = "unix_.+"
hidden = true
[[struct]]
pattern = "Unix[A-Z].+"
hidden = true
[[function]]
pattern = "unix_.+"
hidden = true
[[object]]
pattern = "Win32[A-Z].+"
hidden = true
[[object]]
pattern = "win32_.+"
hidden = true
[[struct]]
pattern = "Win32[A-Z].+"
hidden = true
[[function]]
pattern = "win32_.+"
hidden = true