mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-09-29 10:36:35 +02:00
docs: Add initial support for using gi-docgen for docs
The files here are copied from the docs-gtk-org branch of gtk. This adds gi-docgen to the CI Dockerfiles and ensures the new versions (including the OS upgrades from the previous commit) are used during CI. Helps: #3037
This commit is contained in:
committed by
Philip Withnall
parent
9dd59ba8ad
commit
39e9ef54be
86561
docs/reference/glib/GLib-2.0.gir
Normal file
86561
docs/reference/glib/GLib-2.0.gir
Normal file
File diff suppressed because it is too large
Load Diff
73
docs/reference/glib/glib.toml.in
Normal file
73
docs/reference/glib/glib.toml.in
Normal file
@@ -0,0 +1,73 @@
|
||||
# SPDX-License-Identifier: LGPL-2.1-or-later
|
||||
# Copyright 2023 Matthias Clasen
|
||||
# Copyright 2023 Philip Withnall
|
||||
|
||||
[library]
|
||||
name = "GLib"
|
||||
version = "@VERSION@"
|
||||
browse_url = "https://gitlab.gnome.org/GNOME/glib/"
|
||||
repository_url = "https://gitlab.gnome.org/GNOME/glib.git"
|
||||
website_url = "https://www.gtk.org"
|
||||
docs_url = "https://docs.gtk.org/glib/"
|
||||
authors = "GLib Development Team"
|
||||
license = "LGPL-2.1-or-later"
|
||||
description = "GLib is a general-purpose, portable utility library, which provides many useful data types, macros, type conversions, string utilities, file utilities, a mainloop abstraction, and so on."
|
||||
related = [ "GModule-2.0", "GObject-2.0", "Gio-2.0" ]
|
||||
devhelp = true
|
||||
search_index = true
|
||||
|
||||
[related."GModule-2.0"]
|
||||
name = "GModule"
|
||||
description = "Portable API for dynamically loading modules"
|
||||
docs_url = "https://docs.gtk.org/gmodule/"
|
||||
|
||||
[related."GObject-2.0"]
|
||||
name = "GObject"
|
||||
description = "The base type system library"
|
||||
docs_url = "https://docs.gtk.org/gobject/"
|
||||
|
||||
[related."Gio-2.0"]
|
||||
name = "GIO"
|
||||
description = "GObject Interfaces and Objects, Networking, IPC, and I/O"
|
||||
docs_url = "https://docs.gtk.org/gio/"
|
||||
|
||||
[theme]
|
||||
name = "basic"
|
||||
show_index_summary = true
|
||||
show_class_hierarchy = true
|
||||
|
||||
[extra]
|
||||
urlmap_file = "urlmap.js"
|
||||
# The same order will be used when generating the index
|
||||
content_files = [
|
||||
]
|
||||
content_images = [
|
||||
"Sorted_binary_tree_breadth-first_traversal.svg",
|
||||
"Sorted_binary_tree_inorder.svg",
|
||||
"Sorted_binary_tree_postorder.svg",
|
||||
"Sorted_binary_tree_preorder.svg",
|
||||
]
|
||||
|
||||
[[object]]
|
||||
pattern = "DEPRECATED_IN_2_*"
|
||||
hidden = true
|
||||
|
||||
[[object]]
|
||||
pattern = "DEPRECATED_MACRO_IN_2_*"
|
||||
hidden = true
|
||||
|
||||
[[object]]
|
||||
pattern = "DEPRECATED_ENUMERATOR_IN_2_*"
|
||||
hidden = true
|
||||
|
||||
[[object]]
|
||||
pattern = "DEPRECATED_TYPE_IN_2_*"
|
||||
hidden = true
|
||||
|
||||
[[object]]
|
||||
name = "test_assert_expected_messages_internal"
|
||||
hidden = true
|
||||
|
||||
[[object]]
|
||||
pattern = "macro__has_*"
|
||||
hidden = true
|
@@ -149,3 +149,26 @@ if get_option('gtk_doc')
|
||||
)
|
||||
endif
|
||||
endif
|
||||
|
||||
# gi-docgen version
|
||||
expand_content_files = [
|
||||
]
|
||||
|
||||
glib_gir = meson.current_source_dir() / 'GLib-2.0.gir'
|
||||
glib_toml = configure_file(input: 'glib.toml.in', output: 'glib.toml', configuration: toml_conf)
|
||||
|
||||
custom_target('glib-docs',
|
||||
input: [ glib_toml, glib_gir ],
|
||||
output: 'glib',
|
||||
command: [
|
||||
gidocgen,
|
||||
'generate',
|
||||
gidocgen_common_args,
|
||||
'--config=@INPUT0@',
|
||||
'--output-dir=@OUTPUT@',
|
||||
'--content-dir=@0@'.format(meson.current_source_dir()),
|
||||
'@INPUT1@',
|
||||
],
|
||||
build_by_default: true,
|
||||
depend_files: expand_content_files,
|
||||
)
|
||||
|
9
docs/reference/glib/urlmap.js
Normal file
9
docs/reference/glib/urlmap.js
Normal file
@@ -0,0 +1,9 @@
|
||||
// SPDX-License-Identifier: LGPL-2.1-or-later
|
||||
// SPDX-FileCopyrightText: 2023 Matthias Clasen
|
||||
var baseURLs = [
|
||||
[ 'GLib', 'https://docs.gtk.org/glib/' ],
|
||||
[ 'GModule', 'https://docs.gtk.org/gmodule/' ],
|
||||
[ 'GObject', 'https://docs.gtk.org/gobject/' ],
|
||||
[ 'Gio', 'https://docs.gtk.org/gio/' ],
|
||||
[ 'Gtk', 'https://docs.gtk.org/gtk4/' ],
|
||||
];
|
Reference in New Issue
Block a user