Merge branch '3287-docs-dirs' into 'main'

docs: Reduce nesting of documentation directories

Closes #3287

See merge request GNOME/glib!3964
This commit is contained in:
Michael Catanzaro 2024-03-13 21:16:48 +00:00
commit c6d4fef43c
8 changed files with 24 additions and 24 deletions

View File

@ -200,13 +200,13 @@ fedora-x86_64:
# Copy the built documentation to an artifact directory. The build for docs.gtk.org # Copy the built documentation to an artifact directory. The build for docs.gtk.org
# can then pull it from there — see https://gitlab.gnome.org/GNOME/gtk/-/blob/docs-gtk-org/README.md # can then pull it from there — see https://gitlab.gnome.org/GNOME/gtk/-/blob/docs-gtk-org/README.md
- mkdir -p _reference/ - mkdir -p _reference/
- mv _build/docs/reference/glib/glib/ _reference/glib/ - mv _build/docs/reference/glib/glib-2.0/ _reference/glib/
- mv _build/docs/reference/glib/glib-unix/ _reference/glib-unix/ - mv _build/docs/reference/glib/glib-unix-2.0/ _reference/glib-unix/
- mv _build/docs/reference/gmodule/gmodule/ _reference/gmodule/ - mv _build/docs/reference/gmodule/gmodule-2.0/ _reference/gmodule/
- mv _build/docs/reference/gobject/gobject/ _reference/gobject/ - mv _build/docs/reference/gobject/gobject-2.0/ _reference/gobject/
- mv _build/docs/reference/gio/gio/ _reference/gio/ - mv _build/docs/reference/gio/gio-2.0/ _reference/gio/
- mv _build/docs/reference/gio/gio-unix/ _reference/gio-unix/ - mv _build/docs/reference/gio/gio-unix-2.0/ _reference/gio-unix/
- mv _build/docs/reference/girepository/girepository/ _reference/girepository/ - mv _build/docs/reference/girepository/girepository-2.0/ _reference/girepository/
artifacts: artifacts:
reports: reports:
junit: junit:
@ -805,11 +805,11 @@ dist-job:
- meson dist -C _build - meson dist -C _build
# Compile again to build the docs # Compile again to build the docs
- meson compile -C _build - meson compile -C _build
- tar -c -J -f "glib-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/glib glib - tar -c -J -f "glib-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/glib glib-2.0
- tar -c -J -f "gmodule-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/gmodule gmodule - tar -c -J -f "gmodule-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/gmodule gmodule-2.0
- tar -c -J -f "gobject-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/gobject gobject - tar -c -J -f "gobject-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/gobject gobject-2.0
- tar -c -J -f "gio-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/gio gio - tar -c -J -f "gio-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/gio gio-2.0
- tar -c -J -f "girepository-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/girepository girepository - tar -c -J -f "girepository-docs-$CI_COMMIT_TAG.tar.xz" -C _build/docs/reference/girepository girepository-2.0
artifacts: artifacts:
paths: paths:
- "${CI_PROJECT_DIR}/_build/glib-docs-$CI_COMMIT_TAG.tar.xz" - "${CI_PROJECT_DIR}/_build/glib-docs-$CI_COMMIT_TAG.tar.xz"

View File

@ -76,5 +76,5 @@ fi
# Copy the built documentation to an artifact directory. The build for docs.gtk.org # Copy the built documentation to an artifact directory. The build for docs.gtk.org
# can then pull it from there — see https://gitlab.gnome.org/GNOME/gtk/-/blob/docs-gtk-org/README.md # can then pull it from there — see https://gitlab.gnome.org/GNOME/gtk/-/blob/docs-gtk-org/README.md
mkdir -p _reference/ mkdir -p _reference/
mv _build/docs/reference/glib/glib-win32/ _reference/glib-win32/ mv _build/docs/reference/glib/glib-win32-2.0/ _reference/glib-win32/
mv _build/docs/reference/gio/gio-win32/ _reference/gio-win32/ mv _build/docs/reference/gio/gio-win32-2.0/ _reference/gio-win32/

View File

@ -48,7 +48,7 @@ if get_option('documentation') and enable_gir
custom_target('gio-docs', custom_target('gio-docs',
input: [ gio_toml, gio_gir[0] ], input: [ gio_toml, gio_gir[0] ],
output: 'gio', output: 'gio-2.0',
command: [ command: [
gidocgen, gidocgen,
'generate', 'generate',
@ -70,7 +70,7 @@ if get_option('documentation') and enable_gir
custom_target('gio-win32-docs', custom_target('gio-win32-docs',
input: [ gio_win32_toml, gio_win32_gir[0] ], input: [ gio_win32_toml, gio_win32_gir[0] ],
output: 'gio-win32', output: 'gio-win32-2.0',
command: [ command: [
gidocgen, gidocgen,
'generate', 'generate',
@ -91,7 +91,7 @@ if get_option('documentation') and enable_gir
custom_target('gio-unix-docs', custom_target('gio-unix-docs',
input: [ gio_unix_toml, gio_unix_gir[0] ], input: [ gio_unix_toml, gio_unix_gir[0] ],
output: 'gio-unix', output: 'gio-unix-2.0',
command: [ command: [
gidocgen, gidocgen,
'generate', 'generate',

View File

@ -34,7 +34,7 @@ if get_option('documentation') and enable_gir
custom_target('girepository-docs', custom_target('girepository-docs',
input: [ girepository_toml, girepository_gir[0] ], input: [ girepository_toml, girepository_gir[0] ],
output: 'girepository', output: 'girepository-2.0',
command: [ command: [
gidocgen, gidocgen,
'generate', 'generate',

View File

@ -106,7 +106,7 @@ if get_option('documentation') and enable_gir
custom_target('glib-docs', custom_target('glib-docs',
input: [ glib_toml, glib_gir[0] ], input: [ glib_toml, glib_gir[0] ],
output: 'glib', output: 'glib-2.0',
command: [ command: [
gidocgen, gidocgen,
'generate', 'generate',
@ -128,7 +128,7 @@ if get_option('documentation') and enable_gir
custom_target('glib-win32-docs', custom_target('glib-win32-docs',
input: [ glib_win32_toml, glib_win32_gir[0] ], input: [ glib_win32_toml, glib_win32_gir[0] ],
output: 'glib-win32', output: 'glib-win32-2.0',
command: [ command: [
gidocgen, gidocgen,
'generate', 'generate',
@ -149,7 +149,7 @@ if get_option('documentation') and enable_gir
custom_target('glib-unix-docs', custom_target('glib-unix-docs',
input: [ glib_unix_toml, glib_unix_gir[0] ], input: [ glib_unix_toml, glib_unix_gir[0] ],
output: 'glib-unix', output: 'glib-unix-2.0',
command: [ command: [
gidocgen, gidocgen,
'generate', 'generate',

View File

@ -7,7 +7,7 @@ if get_option('documentation') and enable_gir
custom_target('gmodule-docs', custom_target('gmodule-docs',
input: [ gmodule_toml, gmodule_gir[0] ], input: [ gmodule_toml, gmodule_gir[0] ],
output: 'gmodule', output: 'gmodule-2.0',
command: [ command: [
gidocgen, gidocgen,
'generate', 'generate',

View File

@ -34,7 +34,7 @@ if get_option('documentation') and enable_gir
custom_target('gobject-docs', custom_target('gobject-docs',
input: [ gobject_toml, gobject_gir[0] ], input: [ gobject_toml, gobject_gir[0] ],
output: 'gobject', output: 'gobject-2.0',
command: [ command: [
gidocgen, gidocgen,
'generate', 'generate',

View File

@ -17,7 +17,7 @@ if get_option('documentation') and enable_gir
] ]
endif endif
docs_dir = glib_datadir / 'doc' / 'glib-2.0' docs_dir = glib_datadir / 'doc'
subdir('glib') subdir('glib')
subdir('gmodule') subdir('gmodule')