AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2025-01-01 00:11:29 +00:00
Code Issues Projects Releases Wiki Activity
7a608bda27
gtk/docs/reference/gsk/gsk4.toml.in

39 lines
967 B
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/gsk4/"
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: 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
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 = ["Graphene-1.0", "Gdk-4.0"]
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."Graphene-1.0"]
name = "Graphene"
description = "A thin layer of mathematical types for 3D libraries"
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://ebassi.github.io/graphene/docs/"
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."Gdk-4.0"]
name = "GDK"
description = "The GTK windowing system abstraction"
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/"
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]
content_images = [
"gtk-logo.svg",
]
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