From 99b0d11c78c9fde7f5facbdf16ea5c6ab1e48e16 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 10 Feb 2021 16:49:26 -0500 Subject: Generate Pango API docs 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. --- docs/pangocairo.toml.in | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/pangocairo.toml.in (limited to 'docs/pangocairo.toml.in') diff --git a/docs/pangocairo.toml.in b/docs/pangocairo.toml.in new file mode 100644 index 00000000..2e0124e3 --- /dev/null +++ b/docs/pangocairo.toml.in @@ -0,0 +1,34 @@ +[library] +namespace = "PangoCairo" +version = "@PANGO_VERSION@" +browse_url = "https://gitlab.gnome.org/GNOME/pango/" +repository_url = "https://gitlab.gnome.org/GNOME/pango.git" +website_url = "https://www.pango.org" +authors = "Owen Taylor, Behdad Esfahbod" +logo_url = "pango-name.png" +license = "GPL-2.1-or-later" +description = "Cairo support for Pango" +dependencies = [ "Pango-1.0", "cairo-1.0" ] + + [dependencies."Pango-1.0"] + name = "Pango" + description = "A library for layout out and rendering of text" + docs_url = "https://developer.gnome.org/pango/stable" + + [dependencies."cairo-1.0"] + name = "Cairo" + description = "A vector graphics library" + docs_url = "https://www.cairographics.org/manual/" + +[theme] +name = "basic" + +[source-location] +base_url = "https://gitlab.gnome.org/GNOME/pango/-/blob/master/" + +[extra] + +content_images = [ + "pango-name.png", + "rotated-text.png" +] -- cgit v1.2.1 From 3570fd0a1d411cb10903f4f22e3cc6dd890ed011 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 17 Feb 2021 00:54:17 -0500 Subject: docs: Convert the pangocairo section to pango_cairo.md --- docs/pangocairo.toml.in | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/pangocairo.toml.in') diff --git a/docs/pangocairo.toml.in b/docs/pangocairo.toml.in index 2e0124e3..656be8d2 100644 --- a/docs/pangocairo.toml.in +++ b/docs/pangocairo.toml.in @@ -27,6 +27,9 @@ name = "basic" base_url = "https://gitlab.gnome.org/GNOME/pango/-/blob/master/" [extra] +content_files = [ + "pango_cairo.md", +] content_images = [ "pango-name.png", -- cgit v1.2.1 From 9daeb21741c86116b92b5ce1b6afdbb20e576d23 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Thu, 18 Feb 2021 20:19:22 -0500 Subject: Tell gi-docgen to produce index summaries --- docs/pangocairo.toml.in | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/pangocairo.toml.in') diff --git a/docs/pangocairo.toml.in b/docs/pangocairo.toml.in index 656be8d2..bba45161 100644 --- a/docs/pangocairo.toml.in +++ b/docs/pangocairo.toml.in @@ -22,6 +22,7 @@ dependencies = [ "Pango-1.0", "cairo-1.0" ] [theme] name = "basic" +show_index_summary = true [source-location] base_url = "https://gitlab.gnome.org/GNOME/pango/-/blob/master/" -- cgit v1.2.1 From 85555e4ec42ea99e97f738fd6ccd31860f464fcf Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Thu, 11 Mar 2021 14:06:13 -0500 Subject: docs: Add search and fix crosslinks --- docs/pangocairo.toml.in | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/pangocairo.toml.in') diff --git a/docs/pangocairo.toml.in b/docs/pangocairo.toml.in index bba45161..3d41b82f 100644 --- a/docs/pangocairo.toml.in +++ b/docs/pangocairo.toml.in @@ -9,11 +9,13 @@ logo_url = "pango-name.png" license = "GPL-2.1-or-later" description = "Cairo support for Pango" dependencies = [ "Pango-1.0", "cairo-1.0" ] +devhelp = true +search_index = true [dependencies."Pango-1.0"] name = "Pango" description = "A library for layout out and rendering of text" - docs_url = "https://developer.gnome.org/pango/stable" + docs_url = "../Pango/" [dependencies."cairo-1.0"] name = "Cairo" -- cgit v1.2.1