[devhelp] docs: include the API version in the reference manual
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [devhelp] docs: include the API version in the reference manual
- Date: Sat, 16 Jun 2018 18:50:34 +0000 (UTC)
commit 0fe03c56b52615250db9585e4d52b760496a1733
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sat Jun 16 19:10:13 2018 +0200
docs: include the API version in the reference manual
Without hardcoding the API version.
This will be useful when the libdevhelp git repo will be created.
docs/reference/devhelp-docs.xml | 2 +-
docs/reference/meson.build | 10 ++++++++--
docs/reference/xml/gtkdocentities.ent.in | 1 +
docs/reference/xml/meson.build | 1 +
4 files changed, 11 insertions(+), 3 deletions(-)
---
diff --git a/docs/reference/devhelp-docs.xml b/docs/reference/devhelp-docs.xml
index 50f20f87..af2762e2 100644
--- a/docs/reference/devhelp-docs.xml
+++ b/docs/reference/devhelp-docs.xml
@@ -8,7 +8,7 @@
]>
<book id="index">
<bookinfo>
- <title>&package_name; Reference Manual</title>
+ <title>&package_name; &package_api_version; Reference Manual</title>
<releaseinfo>
For &package_string;.
</releaseinfo>
diff --git a/docs/reference/meson.build b/docs/reference/meson.build
index c5511bb0..ea6b5f35 100644
--- a/docs/reference/meson.build
+++ b/docs/reference/meson.build
@@ -1,12 +1,18 @@
subdir('xml')
+configure_file(
+ input : 'devhelp-sections.txt',
+ output : 'devhelp-@0 -sections txt'.format(LIBDEVHELP_API_VERSION),
+ configuration : configuration_data() # TODO use "copy : true" when Meson 0.47 is released.
+)
+
GNOME.gtkdoc(
- 'devhelp',
+ 'devhelp-@0@'.format(LIBDEVHELP_API_VERSION),
main_xml : 'devhelp-docs.xml',
src_dir : include_directories('../../devhelp/'),
dependencies : SHARED_LIBDEVHELP_DECLARED_DEP,
scan_args : ['--rebuild-types'],
- gobject_typesfile : 'devhelp.types',
+ gobject_typesfile : 'devhelp-@0@.types'.format(LIBDEVHELP_API_VERSION),
content_files : [
'api-breaks.xml'
],
diff --git a/docs/reference/xml/gtkdocentities.ent.in b/docs/reference/xml/gtkdocentities.ent.in
index 5d964322..4b6fc27e 100644
--- a/docs/reference/xml/gtkdocentities.ent.in
+++ b/docs/reference/xml/gtkdocentities.ent.in
@@ -1,2 +1,3 @@
<!ENTITY package_name "@PACKAGE_NAME@">
<!ENTITY package_string "@PACKAGE_STRING@">
+<!ENTITY package_api_version "@PACKAGE_API_VERSION@">
diff --git a/docs/reference/xml/meson.build b/docs/reference/xml/meson.build
index 30f8bc08..008ce7a6 100644
--- a/docs/reference/xml/meson.build
+++ b/docs/reference/xml/meson.build
@@ -1,6 +1,7 @@
gtkdocentities_conf_data = configuration_data()
gtkdocentities_conf_data.set('PACKAGE_NAME', 'Devhelp')
gtkdocentities_conf_data.set('PACKAGE_STRING', 'Devhelp @0@'.format(meson.project_version()))
+gtkdocentities_conf_data.set('PACKAGE_API_VERSION', LIBDEVHELP_API_VERSION)
gtkdocentities_filename = 'gtkdocentities.ent'
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]