Commit 24abf52d authored by Romain Bouvier's avatar Romain Bouvier
Browse files

Update gtk-doc for thunarx-python

- Use a more standard makefile for gtk-doc
- gtk doc should be inlined in the source, but for now keep what we have
  in docs/reference/ dir
parent 5f4edd0b
......@@ -25,5 +25,7 @@ configure.ac
docs/*.html
docs/*.png
docs/*.css
docs/reference/html
docs/reference/xml
builddate.xml
*.devhelp2
ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
SUBDIRS = src examples
if ENABLE_GTK_DOC
SUBDIRS += docs
CLEANFILES = html.stamp
endif
SUBDIRS = src examples docs
DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc
......@@ -121,7 +121,8 @@ Makefile
src/Makefile
examples/Makefile
docs/Makefile
docs/reference/entities.docbook
docs/reference/Makefile
docs/reference/version.xml
])
dnl ***************************
......
docsdir = $(docdir)
# vi:set ts=8 sw=8 noet ai nocindent:
BUILDDIR = $(top_builddir)/docs
REF_VERSION = $(VERSION)
FULL_VERSION = $(VERSION)
XMLFILES = \
reference/thunarx-python-ref.xml \
reference/thunarx-python-overview.xml \
reference/thunarx-python-overview-example.xml \
reference/thunarx-python-class-reference.xml \
reference/thunarx-python-provider-reference.xml \
reference/thunarx-python-menu-provider.xml \
reference/thunarx-python-menu-item.xml \
reference/thunarx-python-menu.xml \
reference/thunarx-python-property-page.xml \
reference/thunarx-python-property-page-provider.xml \
reference/thunarx-python-renamer.xml \
reference/thunarx-python-renamer-provider.xml \
reference/thunarx-python-preferences-provider.xml \
reference/thunarx-python-file-info.xml
HTMLdir = $(HTML_DIR)/thunarx-python
HTML_DATA = \
index.html \
thunarx-python-overview.html \
thunarx-python-overview-example.html \
thunarx-python-class-reference.html \
thunarx-python-provider-reference.html \
class-thunarx-python-menu-provider.html \
class-thunarx-python-menu-item.html \
class-thunarx-python-menu.html \
class-thunarx-python-property-page.html \
class-thunarx-python-property-page-provider.html \
class-thunarx-python-renamer.html \
class-thunarx-python-renamer-provider.html \
class-thunarx-python-preferences-provider.html \
class-thunarx-python-file-info.html \
thunarx-python.devhelp2 \
up.png up-insensitive.png \
right.png right-insensitive.png \
left.png left-insensitive.png home.png \
style.css
BUILT_SOURCES = \
reference/builddate.xml \
$(HTML_DATA)
CLEANFILES = \
thunarx-python-ref.* \
reference/builddate.xml \
$(HTML_DATA)
EXTRA_DIST = \
$(XMLFILES) \
$(HTML_DATA)
REFERENCE_DEPS = \
reference \
$(XMLFILES)
if ENABLE_GTK_DOC
reference/builddate.xml: $(REFERENCE_DEPS)
$(PYTHON) -c 'import datetime; print(datetime.date.today())' > $@
$(HTML_DATA): $(REFERENCE_DEPS) reference/builddate.xml
$(GTKDOC_MKHTML) \
thunarx-python $(srcdir)/reference/thunarx-python-ref.xml \
--path $(BUILDDIR)/reference:$(srcdir)/reference
touch $@
endif
SUBDIRS = \
reference
# -*- mode: makefile -*-
#
# Makefile.am - template makefile for gtk-doc module
# Copyright (C) 2007-2017 Stefan Sauer
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# As a special exception, the above copyright owner gives unlimited
# permission to copy, distribute and modify this Makefile.am template.
# You need not follow the terms of the GNU General Public License when
# using or distributing such Makefile.am files, even though portions of
# the text of the Makefile.am appear in them. The GNU General Public
# License (GPL) does govern all other use of the material that constitutes
# the Makefile.am template.
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
# of using the various options.
# The name of the module, e.g. 'glib'.
DOC_MODULE=thunarx-python
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
#DOC_MODULE_VERSION=2
# The top-level XML file.
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
# Directories containing the source code.
# gtk-doc will search all .c and .h files beneath these paths
# for inline comments documenting functions and macros.
# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
DOC_SOURCE_DIR=
# Extra options to pass to gtkdoc-scangobj. Normally not needed.
SCANGOBJ_OPTIONS=
# Extra options to supply to gtkdoc-scan.
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
SCAN_OPTIONS=
# Extra options to supply to gtkdoc-mkdb
# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
MKDB_OPTIONS=--xml-mode --output-format=xml
# Extra options to supply to gtkdoc-mkhtml
MKHTML_OPTIONS=
#--path $(srcdir)/reference
# Extra options to supply to gtkdoc-fixref. Normally not needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
FIXXREF_OPTIONS=
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
HFILE_GLOB=
CFILE_GLOB=
# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
EXTRA_HFILES=
# Header files or dirs to ignore when scanning. Use base file/dir names
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
IGNORE_HFILES=
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
HTML_IMAGES=
# Extra files that are included by $(DOC_MAIN_SGML_FILE).
# e.g. content_files=running.xml building.xml changes-2.0.xml
content_files=version.xml \
thunarx-python-overview.xml \
thunarx-python-overview-example.xml \
thunarx-python-class-reference.xml \
thunarx-python-provider-reference.xml \
thunarx-python-menu-provider.xml \
thunarx-python-menu-item.xml \
thunarx-python-menu.xml \
thunarx-python-property-page.xml \
thunarx-python-property-page-provider.xml \
thunarx-python-renamer.xml \
thunarx-python-renamer-provider.xml \
thunarx-python-preferences-provider.xml \
thunarx-python-file-info.xml
# Files where gtk-doc abbreviations (#GtkWidget) are expanded
# e.g. expand_content_files=running.xml
expand_content_files=
# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
# Only needed if you are using gtkdoc-scangobj to dynamically query widget
# signals and properties.
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
GTKDOC_CFLAGS=
GTKDOC_LIBS=
# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make
# Other files to distribute
EXTRA_DIST += \
version.xml.in
thunarx-python-overview.xml \
thunarx-python-overview-example.xml \
thunarx-python-class-reference.xml \
thunarx-python-provider-reference.xml \
thunarx-python-menu-provider.xml \
thunarx-python-menu-item.xml \
thunarx-python-menu.xml \
thunarx-python-property-page.xml \
thunarx-python-property-page-provider.xml \
thunarx-python-renamer.xml \
thunarx-python-renamer-provider.xml \
thunarx-python-preferences-provider.xml \
thunarx-python-file-info.xml
-include $(top_srcdir)/git.mk
<?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"
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % entities SYSTEM "entities.docbook">
%entities;
<!ENTITY builddate SYSTEM "builddate.xml">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
%gtkdocentities;
]>
<book id="thunarx-python-reference" xmlns:xi="http://www.w3.org/2001/XInclude">
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<pubdate>&builddate;</pubdate>
<title>thunarx-python Reference Manual</title>
<edition>Reference Manual for thunarx-python &version;</edition>
<releaseinfo>For thunarx-python version &version;</releaseinfo>
<edition>Reference Manual for thunarx-python</edition>
<releaseinfo>For thunarx-python version <xi:include href="version.xml" parse="text"/></releaseinfo>
<authorgroup>
<author>
<firstname>Adam</firstname>
......@@ -22,13 +21,8 @@
<para>This reference describes the classes of the thunarx-python module.</para>
</abstract>
</bookinfo>
<toc>
</toc>
<!-- the reference page chapters for the thunarx-python classes -->
<xi:include href="thunarx-python-overview.xml"/>
<xi:include href="thunarx-python-class-reference.xml"/>
<xi:include href="thunarx-python-provider-reference.xml"/>
<xi:include href="thunarx-python-overview.xml"/>
<xi:include href="thunarx-python-class-reference.xml"/>
<xi:include href="thunarx-python-provider-reference.xml"/>
</book>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment