GNOME.org
 

[libchamplain] Fix documentation generation using meson

commit a33681416241e42af19a850ac29af026c2afebbd
Author: Jiří Techet <techet gmail com>
Date:   Fri Feb 8 21:36:41 2019 +0100

    Fix documentation generation using meson
    
    Meson build removed "lib" prefix from the docs directory name. Because
    of this, also files like -sections.txt have to drop the "lib" prefix,
    otherwise they are ignored when generating documentation.
    
    Also use xml mode for generating docs and rename sgml file to xml.

 .gitignore                                         | 48 +++++++++++-----------
 docs/reference-gtk/Makefile.am                     |  6 +--
 ...mplain-gtk-docs.sgml => champlain-gtk-docs.xml} |  0
 ...gtk-sections.txt => champlain-gtk-sections.txt} |  0
 ...{libchamplain-gtk.types => champlain-gtk.types} |  0
 docs/reference-gtk/meson.build                     |  5 ++-
 docs/reference/Makefile.am                         |  6 +--
 .../{libchamplain-docs.sgml => champlain-docs.xml} |  0
 ...amplain-sections.txt => champlain-sections.txt} |  0
 .../{libchamplain.types => champlain.types}        |  0
 docs/reference/meson.build                         |  5 ++-
 11 files changed, 36 insertions(+), 34 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index debbf40..fd1ffef 100644
--- a/.gitignore
+++ b/.gitignore
@@ -53,35 +53,35 @@ demos/launcher-vala.c
 demos/markers-vala.c
 depcomp
 compile
-docs/reference-gtk/libchamplain-gtk-undeclared.txt
-docs/reference-gtk/libchamplain-gtk-undocumented.txt
-docs/reference-gtk/libchamplain-gtk-unused.txt
-docs/reference-gtk/libchamplain-gtk.args
-docs/reference-gtk/libchamplain-gtk.hierarchy
-docs/reference-gtk/libchamplain-gtk.interfaces
-docs/reference-gtk/libchamplain-gtk.prerequisites
-docs/reference-gtk/libchamplain-gtk.signals
+docs/reference-gtk/champlain-gtk-undeclared.txt
+docs/reference-gtk/champlain-gtk-undocumented.txt
+docs/reference-gtk/champlain-gtk-unused.txt
+docs/reference-gtk/champlain-gtk.args
+docs/reference-gtk/champlain-gtk.hierarchy
+docs/reference-gtk/champlain-gtk.interfaces
+docs/reference-gtk/champlain-gtk.prerequisites
+docs/reference-gtk/champlain-gtk.signals
 docs/reference-gtk/version.xml
-docs/reference-gtk/libchamplain-gtk-decl-list.txt
-docs/reference-gtk/libchamplain-gtk-decl.txt
-docs/reference-gtk/libchamplain-gtk-overrides.txt
-docs/reference-gtk/libchamplain-gtk-types.txt
+docs/reference-gtk/champlain-gtk-decl-list.txt
+docs/reference-gtk/champlain-gtk-decl.txt
+docs/reference-gtk/champlain-gtk-overrides.txt
+docs/reference-gtk/champlain-gtk-types.txt
 docs/reference-gtk/html/*.*
 docs/reference-gtk/tmpl/*.*
 docs/reference-gtk/xml/*.*
 docs/reference/version.xml
-docs/reference/libchamplain-undeclared.txt
-docs/reference/libchamplain-undocumented.txt
-docs/reference/libchamplain-unused.txt
-docs/reference/libchamplain.args
-docs/reference/libchamplain.hierarchy
-docs/reference/libchamplain.interfaces
-docs/reference/libchamplain.prerequisites
-docs/reference/libchamplain.signals
-docs/reference/libchamplain-decl-list.txt
-docs/reference/libchamplain-decl.txt
-docs/reference/libchamplain-overrides.txt
-docs/reference/libchamplain-types.txt
+docs/reference/champlain-undeclared.txt
+docs/reference/champlain-undocumented.txt
+docs/reference/champlain-unused.txt
+docs/reference/champlain.args
+docs/reference/champlain.hierarchy
+docs/reference/champlain.interfaces
+docs/reference/champlain.prerequisites
+docs/reference/champlain.signals
+docs/reference/champlain-decl-list.txt
+docs/reference/champlain-decl.txt
+docs/reference/champlain-overrides.txt
+docs/reference/champlain-types.txt
 docs/reference/html/*.*
 docs/reference/tmpl/*.*
 docs/reference/xml/*.*
diff --git a/docs/reference-gtk/Makefile.am b/docs/reference-gtk/Makefile.am
index 5bea106..3c10ccf 100644
--- a/docs/reference-gtk/Makefile.am
+++ b/docs/reference-gtk/Makefile.am
@@ -4,14 +4,14 @@
 AUTOMAKE_OPTIONS = 1.6
 
 # The name of the module, e.g. 'glib'.
-DOC_MODULE=libchamplain-gtk
+DOC_MODULE=champlain-gtk
 
 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
 DOC_MODULE_VERSION=@CHAMPLAIN_API_VERSION@
 
 
 # The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
 
 # The directory containing the source code. Relative to $(srcdir).
 # gtk-doc will search all .c & .h files beneath here for inline comments
@@ -28,7 +28,7 @@ SCAN_OPTIONS=--rebuild-types --deprecated-guards="GTK_DISABLE_DEPRECATED"
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=gtk_champlain
+MKDB_OPTIONS=--xml-mode --output-format=xml --name-space=gtk_champlain
 
 # Extra options to supply to gtkdoc-mktmpl
 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
diff --git a/docs/reference-gtk/libchamplain-gtk-docs.sgml b/docs/reference-gtk/champlain-gtk-docs.xml
similarity index 100%
rename from docs/reference-gtk/libchamplain-gtk-docs.sgml
rename to docs/reference-gtk/champlain-gtk-docs.xml
diff --git a/docs/reference-gtk/libchamplain-gtk-sections.txt b/docs/reference-gtk/champlain-gtk-sections.txt
similarity index 100%
rename from docs/reference-gtk/libchamplain-gtk-sections.txt
rename to docs/reference-gtk/champlain-gtk-sections.txt
diff --git a/docs/reference-gtk/libchamplain-gtk.types b/docs/reference-gtk/champlain-gtk.types
similarity index 100%
rename from docs/reference-gtk/libchamplain-gtk.types
rename to docs/reference-gtk/champlain-gtk.types
diff --git a/docs/reference-gtk/meson.build b/docs/reference-gtk/meson.build
index 340b629..9e43cab 100644
--- a/docs/reference-gtk/meson.build
+++ b/docs/reference-gtk/meson.build
@@ -36,8 +36,9 @@ libchamplain_gtk_reference_fixxref_args = [
 
 gnome.gtkdoc(
   package_gtk_name,
-  main_sgml: 'libchamplain-gtk-docs.sgml',
-  gobject_typesfile: files('libchamplain-gtk.types'),
+  main_xml: 'champlain-gtk-docs.xml',
+  mode: 'xml',
+  gobject_typesfile: files('champlain-gtk.types'),
   src_dir: libchamplain_gtk_srcdir,
   dependencies: libchamplain_gtk_dep,
   scan_args: libchamplain_gtk_reference_scan_args,
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index d0f019e..fed635e 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -4,14 +4,14 @@
 AUTOMAKE_OPTIONS = 1.6
 
 # The name of the module, e.g. 'glib'.
-DOC_MODULE=libchamplain
+DOC_MODULE=champlain
 
 # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
 DOC_MODULE_VERSION=@CHAMPLAIN_API_VERSION@
 
 
 # The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
 
 # The directory containing the source code. Relative to $(srcdir).
 # gtk-doc will search all .c & .h files beneath here for inline comments
@@ -28,7 +28,7 @@ SCAN_OPTIONS=--rebuild-types --deprecated-guards="GTK_DISABLE_DEPRECATED"
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=champlain
+MKDB_OPTIONS=--xml-mode --output-format=xml --name-space=champlain
 
 # Extra options to supply to gtkdoc-mktmpl
 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/champlain-docs.xml
similarity index 100%
rename from docs/reference/libchamplain-docs.sgml
rename to docs/reference/champlain-docs.xml
diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/champlain-sections.txt
similarity index 100%
rename from docs/reference/libchamplain-sections.txt
rename to docs/reference/champlain-sections.txt
diff --git a/docs/reference/libchamplain.types b/docs/reference/champlain.types
similarity index 100%
rename from docs/reference/libchamplain.types
rename to docs/reference/champlain.types
diff --git a/docs/reference/meson.build b/docs/reference/meson.build
index 42da149..2533f00 100644
--- a/docs/reference/meson.build
+++ b/docs/reference/meson.build
@@ -56,8 +56,9 @@ libchamplain_reference_fixxref_args = [
 
 gnome.gtkdoc(
   package_name,
-  main_sgml: 'libchamplain-docs.sgml',
-  gobject_typesfile: files('libchamplain.types'),
+  main_xml: 'champlain-docs.xml',
+  mode: 'xml',
+  gobject_typesfile: files('champlain.types'),
   src_dir: libchamplain_srcdir,
   dependencies: libchamplain_dep,
   scan_args: libchamplain_reference_scan_args,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]