AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity
12858114a2
gtk2/docs/reference/gdk/gdk4.toml.in

111 lines
3.0 KiB
TOML
Raw Normal View History

Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
[library]
version = "@version@"
browse_url = "https://gitlab.gnome.org/GNOME/gtk/"
repository_url = "https://gitlab.gnome.org/GNOME/gtk.git"
website_url = "https://www.gtk.org"
docs: Enable OpenSearch on our references By adding the `docs_url` key in the project configuration file, gi-docgen will generate an OpenSearch XML file, which allows to add docs.gtk.org/<reference> as a "search engine" in web browsers.
2021-11-15 15:31:35 +00:00
docs_url = "https://docs.gtk.org/gdk4/"
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
authors = "GTK Development Team"
logo_url = "gtk-logo.svg"
docs: Fix the license field It's LGPL-2.1-or-later, not GPL.
2021-06-03 08:11:09 +00:00
license = "LGPL-2.1-or-later"
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
description = "The GTK toolkit"
docs: Split dependencies from related libraries We currently list everything as a dependencies, regardless of whether it actually is; this is a source of confusion for users that read the GTK documentation. Gi-docgen has a new "related" key in the project configuration which allows us to list libraries that are merely related to the namespace we are documenting; the "dependencies" key is used to document the actual namespace dependencies, now.
2022-02-12 17:03:22 +00:00
dependencies = ["GObject-2.0", "Gio-2.0", "cairo-1.0", "Pango-1.0", "GdkPixbuf-2.0"]
docs: Generate the DevHelp file for our namespaces
2021-02-19 22:09:34 +00:00
devhelp = true
docs: Enable search
2021-03-11 16:36:48 +00:00
search_index = true
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
[dependencies."GObject-2.0"]
name = "GObject"
description = "The base type system library"
docs: Update the URL for related documentation And install the gi-docgen project files for GDK.
2021-07-31 18:05:33 +00:00
docs_url = "https://docs.gtk.org/gobject/"
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
docs: Split dependencies from related libraries We currently list everything as a dependencies, regardless of whether it actually is; this is a source of confusion for users that read the GTK documentation. Gi-docgen has a new "related" key in the project configuration which allows us to list libraries that are merely related to the namespace we are documenting; the "dependencies" key is used to document the actual namespace dependencies, now.
2022-02-12 17:03:22 +00:00
[dependencies."Gio-2.0"]
docs: Fix dependency names When gi-docgen added the "related" key, it also began checking that the dependencies were actually dependencies otherwise they aren't listed as dependencies. The capitalization needs to match the namespace.
2023-01-13 22:24:33 +00:00
name = "Gio"
docs: Split dependencies from related libraries We currently list everything as a dependencies, regardless of whether it actually is; this is a source of confusion for users that read the GTK documentation. Gi-docgen has a new "related" key in the project configuration which allows us to list libraries that are merely related to the namespace we are documenting; the "dependencies" key is used to document the actual namespace dependencies, now.
2022-02-12 17:03:22 +00:00
description = "GObject Interfaces and Objects, Networking, IPC, and I/O"
docs_url = "https://docs.gtk.org/gio/"
docs: Drop gtk-doc files We don't use gtk-doc to generate our API reference, so we don't need its files lying around any more.
2021-02-18 12:59:09 +00:00
[dependencies."cairo-1.0"]
docs: Fix dependency names When gi-docgen added the "related" key, it also began checking that the dependencies were actually dependencies otherwise they aren't listed as dependencies. The capitalization needs to match the namespace.
2023-01-13 22:24:33 +00:00
name = "cairo"
docs: Drop gtk-doc files We don't use gtk-doc to generate our API reference, so we don't need its files lying around any more.
2021-02-18 12:59:09 +00:00
description = "A 2D graphics library with support for multiple output devices"
docs_url = "https://www.cairographics.org/manual/"
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
[dependencies."Pango-1.0"]
name = "Pango"
description = "Text shaping and rendering"
docs: Update the links to the docs of GTK dependencies Use docs.gtk.org where appropriate. Fixes: #3817
2021-03-31 19:51:27 +00:00
docs_url = "https://docs.gtk.org/Pango/"
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
docs: Split dependencies from related libraries We currently list everything as a dependencies, regardless of whether it actually is; this is a source of confusion for users that read the GTK documentation. Gi-docgen has a new "related" key in the project configuration which allows us to list libraries that are merely related to the namespace we are documenting; the "dependencies" key is used to document the actual namespace dependencies, now.
2022-02-12 17:03:22 +00:00
[dependencies."GdkPixbuf-2.0"]
name = "GdkPixbuf"
description = "Image data loading"
docs_url = "https://docs.gtk.org/gdk-pixbuf/"
related = ["GdkWayland-4.0", "GdkX11-4.0"]
[related."GdkWayland-4.0"]
docs: Add backend links to the gdk docs These are placeholders for when we know how to link across namespaces.
2021-02-21 15:39:26 +00:00
name = "GdkWayland"
description = "GDK Wayland Backend"
docs: Update the links to the docs of GTK dependencies Use docs.gtk.org where appropriate. Fixes: #3817
2021-03-31 19:51:27 +00:00
docs_url = "https://docs.gtk.org/gdk4-wayland/"
docs: Add backend links to the gdk docs These are placeholders for when we know how to link across namespaces.
2021-02-21 15:39:26 +00:00
docs: Split dependencies from related libraries We currently list everything as a dependencies, regardless of whether it actually is; this is a source of confusion for users that read the GTK documentation. Gi-docgen has a new "related" key in the project configuration which allows us to list libraries that are merely related to the namespace we are documenting; the "dependencies" key is used to document the actual namespace dependencies, now.
2022-02-12 17:03:22 +00:00
[related."GdkX11-4.0"]
docs: Add backend links to the gdk docs These are placeholders for when we know how to link across namespaces.
2021-02-21 15:39:26 +00:00
name = "GdkX11"
description = "GDK X11 Backend"
docs: Update the links to the docs of GTK dependencies Use docs.gtk.org where appropriate. Fixes: #3817
2021-03-31 19:51:27 +00:00
docs_url = "https://docs.gtk.org/gdk4-x11/"
docs: Add backend links to the gdk docs These are placeholders for when we know how to link across namespaces.
2021-02-21 15:39:26 +00:00
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
[theme]
name = "basic"
docs: Show summary in the namespace index
2021-02-18 17:30:03 +00:00
show_index_summary = true
docs: Show class hierarchy in the API references
2021-03-04 17:42:59 +00:00
show_class_hierarchy = true
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
[source-location]
docs: Point source links to the correct branch The default development branch for GTK is now "main".
2022-01-13 14:39:03 +00:00
base_url = "https://gitlab.gnome.org/GNOME/gtk/-/blob/main/"
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
[extra]
docs: Move gdkcairo section to an external file
2021-02-17 14:21:46 +00:00
content_files = [
docs: Move detached sections into their own content file
2021-02-17 17:41:56 +00:00
"keys.md",
docs: Move gdkcairo section to an external file
2021-02-17 14:21:46 +00:00
"cairo.md",
docs: Move detached sections into their own content file
2021-02-17 17:41:56 +00:00
"pango.md",
"wayland.md",
"x11.md",
"macos.md",
docs: Move gdkcairo section to an external file
2021-02-17 14:21:46 +00:00
]
Generate GTK API reference(s) with gi-docgen Stop using gtk-doc, and switch to gi-docgen. The gi-docgen tool generates API references through the introspection data, which has various benefits: - it does not parse C code - it does not generate and run C code to introspect types at build time - it does not present a different API from the one we're exporting Additionally, gi-docgen: - does not generate DocBook XML in order to generate HTML - does not go through xsltproc - parses proper Markdown Which makes it markedly faster than gtk-doc has ever been.
2021-02-10 13:41:53 +00:00
content_images = [
"images/gtk-logo.svg",
"images/rotated-text.png",
"images/default_cursor.png",
"images/help_cursor.png",
"images/pointer_cursor.png",
"images/context_menu_cursor.png",
"images/progress_cursor.png",
"images/wait_cursor.png",
"images/cell_cursor.png",
"images/crosshair_cursor.png",
"images/text_cursor.png",
"images/vertical_text_cursor.png",
"images/alias_cursor.png",
"images/copy_cursor.png",
"images/no_drop_cursor.png",
"images/move_cursor.png",
"images/not_allowed_cursor.png",
"images/grab_cursor.png",
"images/grabbing_cursor.png",
"images/all_scroll_cursor.png",
"images/col_resize_cursor.png",
"images/row_resize_cursor.png",
"images/n_resize_cursor.png",
"images/e_resize_cursor.png",
"images/s_resize_cursor.png",
"images/w_resize_cursor.png",
"images/ne_resize_cursor.png",
"images/nw_resize_cursor.png",
"images/sw_resize_cursor.png",
"images/se_resize_cursor.png",
"images/ew_resize_cursor.png",
"images/ns_resize_cursor.png",
"images/nesw_resize_cursor.png",
"images/nwse_resize_cursor.png",
"images/zoom_in_cursor.png",
"images/zoom_out_cursor.png",
"images/popup-anchors.png",
"images/popup-flip.png",
"images/popup-slide.png",
]
docs: Add URL maps for cross links
2021-03-11 16:46:02 +00:00
urlmap_file = "urlmap.js"
Reference in New Issue Copy Permalink