[retro-gtk/build-doc: 1/2] lol
- From: Adrien Plazas <aplazas src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [retro-gtk/build-doc: 1/2] lol
- Date: Sun, 16 Feb 2020 16:07:48 +0000 (UTC)
commit 13c1d56fcf4ffde7f799ac2f1b44446be469eb67
Author: Adrien Plazas <kekun plazas laposte net>
Date: Sun Feb 16 15:59:38 2020 +0100
lol
doc/meson.build | 50 +++++++++++------------
doc/retro-gtk-doc.xml | 94 +++++++++++++++++++++----------------------
doc/xml/gtkdocentities.ent.in | 9 +++++
doc/xml/meson.build | 12 ++++++
meson_options.txt | 2 +-
5 files changed, 93 insertions(+), 74 deletions(-)
---
diff --git a/doc/meson.build b/doc/meson.build
index 65f3a43..48e087d 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -1,29 +1,28 @@
-
-# subdir('xml')
+subdir('xml')
private_headers = [
- 'retro-cairo-display-private.h',
- 'retro-controller-iterator-private.h',
- 'retro-core-private.h',
- 'retro-core-view-controller-private.h',
- 'retro-disk-control-callback-private.h',
- 'retro-game-info-private.h',
- 'retro-gl-display-private.h',
- 'retro-glsl-filter-private.h',
- 'retro-input-descriptor-private.h',
- 'retro-input-private.h',
- 'retro-keyboard-key-private.h',
- 'retro-keyboard-private.h',
- 'retro-module-private.h',
- 'retro-option-iterator-private.h',
- 'retro-option-private.h',
- 'retro-pa-player-private.h',
- 'retro-pixdata-private.h',
- 'retro-pixel-format-private.h',
- 'retro-rotation-private.h',
- 'retro-system-av-info-private.h',
- 'retro-system-info-private.h',
- 'retro-variable-private.h',
+ # 'retro-cairo-display-private.h',
+ # 'retro-controller-iterator-private.h',
+ # 'retro-core-private.h',
+ # 'retro-core-view-controller-private.h',
+ # 'retro-disk-control-callback-private.h',
+ # 'retro-game-info-private.h',
+ # 'retro-gl-display-private.h',
+ # 'retro-glsl-filter-private.h',
+ # 'retro-input-descriptor-private.h',
+ # 'retro-input-private.h',
+ # 'retro-keyboard-key-private.h',
+ # 'retro-keyboard-private.h',
+ # 'retro-module-private.h',
+ # 'retro-option-iterator-private.h',
+ # 'retro-option-private.h',
+ # 'retro-pa-player-private.h',
+ # 'retro-pixdata-private.h',
+ # 'retro-pixel-format-private.h',
+ # 'retro-rotation-private.h',
+ # 'retro-system-av-info-private.h',
+ # 'retro-system-info-private.h',
+ # 'retro-variable-private.h',
]
# content_files = [
@@ -59,6 +58,5 @@ gnome.gtkdoc(
# ],
install_dir: 'retro-gtk',
# content_files: content_files,
- install: get_option('install-tests'),
+ install: get_option('install-doc'),
)
-
diff --git a/doc/retro-gtk-doc.xml b/doc/retro-gtk-doc.xml
index 78374d0..3397a32 100644
--- a/doc/retro-gtk-doc.xml
+++ b/doc/retro-gtk-doc.xml
@@ -12,7 +12,7 @@
<releaseinfo>
<para>This document is the API reference for &package_name; &package_version;.</para>
<para>
- <ulink type="http" url="&package_url;">Handy</ulink> is a library to help you write apps for
GTK/GNOME based mobile phones.
+ <ulink type="http" url="&package_url;">RetroGTK</ulink> is a library to help you write apps for
GTK/GNOME based mobile phones.
</para>
<para>
If you find any issues in this API reference, please report it using
@@ -21,102 +21,102 @@
</releaseinfo>
<copyright>
- <year>2017-2019</year>
- <holder>Purism SPC</holder>
+ <year>2014-2020</year>
+ <holder>Adrien Plazas</holder>
</copyright>
</bookinfo>
<chapter id="intro">
<title>Introduction</title>
- <xi:include href="build-howto.xml"/>
- <xi:include href="visual-index.xml"/>
+ <!-- <xi:include href="build-howto.xml"/> -->
+ <!-- <xi:include href="visual-index.xml"/> -->
</chapter>
<chapter id="core-api">
<title>Widgets and Objects</title>
- <xi:include href="xml/hdy-action-row.xml"/>
- <xi:include href="xml/hdy-animation.xml"/>
- <xi:include href="xml/hdy-arrows.xml"/>
- <xi:include href="xml/hdy-column.xml"/>
- <xi:include href="xml/hdy-combo-row.xml"/>
- <xi:include href="xml/hdy-dialer.xml"/>
- <xi:include href="xml/hdy-dialer-button.xml"/>
- <xi:include href="xml/hdy-dialer-cycle-button.xml"/>
- <xi:include href="xml/hdy-dialog.xml"/>
- <xi:include href="xml/hdy-enum-value-object.xml"/>
- <xi:include href="xml/hdy-expander-row.xml"/>
- <xi:include href="xml/hdy-header-bar.xml"/>
- <xi:include href="xml/hdy-header-group.xml"/>
- <xi:include href="xml/hdy-keypad.xml"/>
- <xi:include href="xml/hdy-leaflet.xml"/>
- <xi:include href="xml/hdy-paginator.xml"/>
- <xi:include href="xml/hdy-preferences-group.xml"/>
- <xi:include href="xml/hdy-preferences-page.xml"/>
- <xi:include href="xml/hdy-preferences-row.xml"/>
- <xi:include href="xml/hdy-preferences-window.xml"/>
- <xi:include href="xml/hdy-search-bar.xml"/>
- <xi:include href="xml/hdy-squeezer.xml"/>
- <xi:include href="xml/hdy-swipeable.xml"/>
- <xi:include href="xml/hdy-swipe-group.xml"/>
- <xi:include href="xml/hdy-title-bar.xml"/>
- <xi:include href="xml/hdy-value-object.xml"/>
- <xi:include href="xml/hdy-view-switcher.xml"/>
- <xi:include href="xml/hdy-view-switcher-bar.xml"/>
+ <!-- <xi:include href="xml/hdy-action-row.xml"/> -->
+ <!-- <xi:include href="xml/hdy-animation.xml"/> -->
+ <!-- <xi:include href="xml/hdy-arrows.xml"/> -->
+ <!-- <xi:include href="xml/hdy-column.xml"/> -->
+ <!-- <xi:include href="xml/hdy-combo-row.xml"/> -->
+ <!-- <xi:include href="xml/hdy-dialer.xml"/> -->
+ <!-- <xi:include href="xml/hdy-dialer-button.xml"/> -->
+ <!-- <xi:include href="xml/hdy-dialer-cycle-button.xml"/> -->
+ <!-- <xi:include href="xml/hdy-dialog.xml"/> -->
+ <!-- <xi:include href="xml/hdy-enum-value-object.xml"/> -->
+ <!-- <xi:include href="xml/hdy-expander-row.xml"/> -->
+ <!-- <xi:include href="xml/hdy-header-bar.xml"/> -->
+ <!-- <xi:include href="xml/hdy-header-group.xml"/> -->
+ <!-- <xi:include href="xml/hdy-keypad.xml"/> -->
+ <!-- <xi:include href="xml/hdy-leaflet.xml"/> -->
+ <!-- <xi:include href="xml/hdy-paginator.xml"/> -->
+ <!-- <xi:include href="xml/hdy-preferences-group.xml"/> -->
+ <!-- <xi:include href="xml/hdy-preferences-page.xml"/> -->
+ <!-- <xi:include href="xml/hdy-preferences-row.xml"/> -->
+ <!-- <xi:include href="xml/hdy-preferences-window.xml"/> -->
+ <!-- <xi:include href="xml/hdy-search-bar.xml"/> -->
+ <!-- <xi:include href="xml/hdy-squeezer.xml"/> -->
+ <!-- <xi:include href="xml/hdy-swipeable.xml"/> -->
+ <!-- <xi:include href="xml/hdy-swipe-group.xml"/> -->
+ <!-- <xi:include href="xml/hdy-title-bar.xml"/> -->
+ <!-- <xi:include href="xml/hdy-value-object.xml"/> -->
+ <!-- <xi:include href="xml/hdy-view-switcher.xml"/> -->
+ <!-- <xi:include href="xml/hdy-view-switcher-bar.xml"/> -->
</chapter>
<chapter id="helpers">
<title>Helpers</title>
- <xi:include href="xml/hdy-version.xml"/>
- <xi:include href="xml/hdy-main.xml"/>
- <xi:include href="xml/hdy-string-utf8.xml"/>
- <xi:include href="xml/hdy-fold.xml"/>
- <xi:include href="xml/hdy-list-box.xml"/>
+ <!-- <xi:include href="xml/hdy-version.xml"/> -->
+ <!-- <xi:include href="xml/hdy-main.xml"/> -->
+ <!-- <xi:include href="xml/hdy-string-utf8.xml"/> -->
+ <!-- <xi:include href="xml/hdy-fold.xml"/> -->
+ <!-- <xi:include href="xml/hdy-list-box.xml"/> -->
</chapter>
<chapter id="object-tree">
<title>Object Hierarchy</title>
- <xi:include href="xml/tree_index.sgml"/>
+ <!-- <xi:include href="xml/tree_index.sgml"/> -->
</chapter>
<index id="api-index-full">
<title>API Index</title>
- <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ <!-- <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> -->
</index>
<index id="deprecated-api-index" role="deprecated">
<title>Index of deprecated API</title>
- <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ <!-- <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> -->
</index>
<index id="api-index-0-0-6" role="0.0.6">
<title>Index of new symbols in 0.0.6</title>
- <xi:include href="xml/api-index-0.0.6.xml"><xi:fallback /></xi:include>
+ <!-- <xi:include href="xml/api-index-0.0.6.xml"><xi:fallback /></xi:include> -->
</index>
<index id="api-index-0-0-7" role="0.0.7">
<title>Index of new symbols in 0.0.7</title>
- <xi:include href="xml/api-index-0.0.7.xml"><xi:fallback /></xi:include>
+ <!-- <xi:include href="xml/api-index-0.0.7.xml"><xi:fallback /></xi:include> -->
</index>
<index id="api-index-0-0-8" role="0.0.8">
<title>Index of new symbols in 0.0.8</title>
- <xi:include href="xml/api-index-0.0.8.xml"><xi:fallback /></xi:include>
+ <!-- <xi:include href="xml/api-index-0.0.8.xml"><xi:fallback /></xi:include> -->
</index>
<index id="api-index-0-0-10" role="0.0.10">
<title>Index of new symbols in 0.0.10</title>
- <xi:include href="xml/api-index-0.0.10.xml"><xi:fallback /></xi:include>
+ <!-- <xi:include href="xml/api-index-0.0.10.xml"><xi:fallback /></xi:include> -->
</index>
<index id="api-index-0-0-11" role="0.0.11">
<title>Index of new symbols in 0.0.11</title>
- <xi:include href="xml/api-index-0.0.11.xml"><xi:fallback /></xi:include>
+ <!-- <xi:include href="xml/api-index-0.0.11.xml"><xi:fallback /></xi:include> -->
</index>
<index id="api-index-0-0-12" role="0.0.12">
<title>Index of new symbols in 0.0.12</title>
- <xi:include href="xml/api-index-0.0.12.xml"><xi:fallback /></xi:include>
+ <!-- <xi:include href="xml/api-index-0.0.12.xml"><xi:fallback /></xi:include> -->
</index>
<index id="annotations-glossary">
diff --git a/doc/xml/gtkdocentities.ent.in b/doc/xml/gtkdocentities.ent.in
new file mode 100644
index 0000000..45d322c
--- /dev/null
+++ b/doc/xml/gtkdocentities.ent.in
@@ -0,0 +1,9 @@
+<!ENTITY package "@PACKAGE@">
+<!ENTITY package_bugreport "@PACKAGE_BUGREPORT@">
+<!ENTITY package_name "@PACKAGE_NAME@">
+<!ENTITY package_string "@PACKAGE_STRING@">
+<!ENTITY package_tarname "@PACKAGE_TARNAME@">
+<!ENTITY package_url "@PACKAGE_URL@">
+<!ENTITY package_version "@PACKAGE_VERSION@">
+<!ENTITY package_api_version "@PACKAGE_API_VERSION@">
+<!ENTITY package_ver_str "@PACKAGE_API_NAME@">
diff --git a/doc/xml/meson.build b/doc/xml/meson.build
new file mode 100644
index 0000000..59e59c5
--- /dev/null
+++ b/doc/xml/meson.build
@@ -0,0 +1,12 @@
+ent_conf = configuration_data()
+ent_conf.set('PACKAGE', 'retro-gtk')
+ent_conf.set('PACKAGE_BUGREPORT', 'https://source.puri.sm/Librem5/libhandy/issues')
+ent_conf.set('PACKAGE_NAME', 'retro-gtk')
+ent_conf.set('PACKAGE_STRING', 'retro-gtk')
+ent_conf.set('PACKAGE_TARNAME', 'retro-gtk-' + retro_gtk_version)
+ent_conf.set('PACKAGE_URL', 'https://gitlab.gnome.org/GNOME/retro-gtk')
+ent_conf.set('PACKAGE_VERSION', retro_gtk_version)
+ent_conf.set('PACKAGE_API_VERSION', retro_gtk_api_version)
+ent_conf.set('PACKAGE_API_NAME', retro_gtk_module)
+configure_file(input: 'gtkdocentities.ent.in', output: 'gtkdocentities.ent', configuration: ent_conf)
+
diff --git a/meson_options.txt b/meson_options.txt
index 4de8b63..0be41b4 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -11,6 +11,6 @@ option('install-tests', type: 'boolean', value: 'false',
description : 'Install tests')
option('build-doc', type: 'boolean', value: 'true',
description : 'Build API reference documentation')
-option('install-doc', type: 'boolean', value: 'false',
+option('install-doc', type: 'boolean', value: 'true',
description : 'Install API reference documentation')
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]