qulogic/libgnt

Add documentation build.

2018-11-29, Elliott Sales de Andrade
4279805cd2af
Parents c6ed4f6deea1
Children a9fa05036045
Add documentation build.
5 files changed, 123 insertions(+), 1 deletions(-)
  • +1 -1
    bitbucket-pipelines.yml
  • +84 -0
    doc/libgnt-docs.xml
  • +36 -0
    doc/meson.build
  • +1 -0
    doc/version.xml.in
  • +1 -0
    meson.build
    • --- a/bitbucket-pipelines.yml Fri Nov 23 17:55:38 2018 -0500
    +++ b/bitbucket-pipelines.yml Thu Nov 29 23:58:37 2018 -0500
    @@ -8,4 +8,4 @@
    - meson build-pipelines
    - ninja -C build-pipelines
    - ninja -C build-pipelines test
    -
    + - ninja -C build-pipelines libgnt-doc
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/doc/libgnt-docs.xml Thu Nov 29 23:58:37 2018 -0500
    @@ -0,0 +1,84 @@
    +<?xml version="1.0"?>
    +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
    +
    +<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
    +<!ENTITY version SYSTEM "version.xml">
    +]>
    +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
    + <bookinfo>
    + <title>GNT Reference Manual</title>
    + <abstract>
    + <title>GNT &version;</title>
    + <para>
    + GNT (GLib Ncurses Toolkit) is an ncurses toolkit for creating text-mode
    + graphical user interfaces in a fast and easy way.
    + </para>
    + </abstract>
    + </bookinfo>
    +
    + <part id="gnt">
    + <title>GNT API Reference</title>
    +
    + <xi:include href="xml/gnt.xml" />
    + <xi:include href="xml/gntbindable.xml" />
    + <xi:include href="xml/gntbox.xml" />
    + <xi:include href="xml/gntbutton.xml" />
    + <xi:include href="xml/gntcheckbox.xml" />
    + <xi:include href="xml/gntmenuitemcheck.xml" />
    + <xi:include href="xml/gntclipboard.xml" />
    + <xi:include href="xml/gntcolors.xml" />
    + <xi:include href="xml/gntcombobox.xml" />
    + <xi:include href="xml/gntentry.xml" />
    + <xi:include href="xml/gntfilesel.xml" />
    + <xi:include href="xml/gntkeys.xml" />
    + <!-- TODO: document not found. Find it.
    + <xi:include href="xml/gntid.xml" />
    + -->
    + <xi:include href="xml/gntlabel.xml" />
    + <xi:include href="xml/gntline.xml" />
    + <xi:include href="xml/gntmenu.xml" />
    + <xi:include href="xml/gntmenuitem.xml" />
    + <xi:include href="xml/gntprogressbar.xml" />
    + <xi:include href="xml/gntslider.xml" />
    + <xi:include href="xml/gntstyle.xml" />
    + <xi:include href="xml/gnttextview.xml" />
    + <xi:include href="xml/gnttree.xml" />
    + <xi:include href="xml/gntwidget.xml" />
    + <xi:include href="xml/gntwindow.xml" />
    + <xi:include href="xml/gntwm.xml" />
    + <xi:include href="xml/gntws.xml" />
    + <xi:include href="xml/gntutils.xml" />
    + </part>
    +
    + <index id="api-index-full">
    + <title>Index</title>
    + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
    + </index>
    + <index id="api-index-deprecated" role="deprecated">
    + <title>Index of deprecated symbols</title>
    + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
    + </index>
    + <index id="api-index-2.8.0" role="2.8.0">
    + <title>Index of new symbols in 2.8.0</title>
    + <xi:include href="xml/api-index-2.8.0.xml"><xi:fallback /></xi:include>
    + </index>
    + <index id="api-index-2.4.0" role="2.4.0">
    + <title>Index of new symbols in 2.4.0</title>
    + <xi:include href="xml/api-index-2.4.0.xml"><xi:fallback /></xi:include>
    + </index>
    + <index id="api-index-2.3.0" role="2.3.0">
    + <title>Index of new symbols in 2.3.0</title>
    + <xi:include href="xml/api-index-2.3.0.xml"><xi:fallback /></xi:include>
    + </index>
    + <index id="api-index-2.2.0" role="2.2.0">
    + <title>Index of new symbols in 2.2.0</title>
    + <xi:include href="xml/api-index-2.2.0.xml"><xi:fallback /></xi:include>
    + </index>
    + <index id="api-index-2.0.0" role="2.0.0">
    + <title>Index of new symbols in 2.0.0</title>
    + <xi:include href="xml/api-index-2.0.0.xml"><xi:fallback /></xi:include>
    + </index>
    +
    + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
    +</book>
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/doc/meson.build Thu Nov 29 23:58:37 2018 -0500
    @@ -0,0 +1,36 @@
    +DOC_MODULE = 'libgnt'
    +
    +# Header files or dirs to ignore when scanning. Use base file/dir names
    +ignore_hfiles = [
    + 'test',
    + 'wms',
    + 'gntinternal.h',
    + 'gnt-skel.h'
    +]
    +
    +# Extra options to supply to gtkdoc-scan.
    +scan_args = [
    + '--deprecated-guards=GNT_DISABLE_DEPRECATED',
    + '--rebuild-types',
    + '--rebuild-sections',
    + '--ignore-headers=' + ' '.join(ignore_hfiles),
    +]
    +
    +# Extra options to supply to gtkdoc-mkdb.
    +mkdb_args = [
    + '--ignore-files=' + ' '.join(ignore_hfiles),
    +]
    +
    +configure_file(
    + input : 'version.xml.in',
    + output : 'version.xml',
    + configuration : gnt_config)
    +
    +gnome.gtkdoc(DOC_MODULE,
    + main_xml : DOC_MODULE + '-docs.xml',
    + src_dir : libgnt_inc,
    + dependencies : libgnt_dep,
    + install : true,
    + scan_args : scan_args,
    + mkdb_args : mkdb_args,
    + gobject_typesfile : DOC_MODULE + '.types')
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/doc/version.xml.in Thu Nov 29 23:58:37 2018 -0500
    @@ -0,0 +1,1 @@
    +@GNT_VERSION@
    --- a/meson.build Fri Nov 23 17:55:38 2018 -0500
    +++ b/meson.build Thu Nov 29 23:58:37 2018 -0500
    @@ -272,3 +272,4 @@
    subdir('wms')
    subdir('test')
    +subdir('doc')