[nautilus-python] Switch to using gtk-mkhtml for documentation generation
- From: Adam Plumb <adamplumb src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [nautilus-python] Switch to using gtk-mkhtml for documentation generation
- Date: Tue, 2 Jan 2018 16:30:49 +0000 (UTC)
commit 1caa5d137b0b8b8b33b478541f0d14bef772bfe7
Author: Adam Plumb <adamplumb gmail com>
Date: Tue Jan 2 11:29:26 2018 -0500
Switch to using gtk-mkhtml for documentation generation
configure.in | 6 +-
docs/Makefile.am | 89 +++++--------
docs/reference/entities.docbook | 1 -
docs/xsl/common.xsl | 19 ---
docs/xsl/devhelp.xsl | 154 ---------------------
docs/xsl/fixxref.py | 67 ---------
docs/xsl/html.xsl | 285 ---------------------------------------
docs/xsl/pdf-style.xsl | 11 --
docs/xsl/pdf.xsl | 259 -----------------------------------
docs/xsl/ref-html-style.xsl | 54 --------
docs/xsl/style.css | 10 --
src/nautilus-python-object.lo | 12 --
src/nautilus-python.lo | 12 --
13 files changed, 37 insertions(+), 942 deletions(-)
---
diff --git a/configure.in b/configure.in
index 31f7460..4d0a110 100644
--- a/configure.in
+++ b/configure.in
@@ -76,9 +76,9 @@ dnl ---------------------------------
dnl Check for gtk-doc dependencies
dnl ---------------------------------
if test "${enable_gtk_doc}" != no; then
- dnl Check for xsltproc
- AC_PATH_PROG([XSLTPROC], [xsltproc])
- if test -z "$XSLTPROC"; then
+ dnl Check for gtkdoc-mkhtml
+ AC_PATH_PROG([GTKDOC_MKHTML], [gtkdoc-mkhtml])
+ if test -z "$GTKDOC_MKHTML"; then
echo " disabling generation of docs"
enable_gtk_doc=no
fi
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 015b552..e7ce215 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -3,9 +3,6 @@ BUILDDIR = $(top_builddir)/docs
REF_VERSION = $(VERSION)
FULL_VERSION = $(VERSION)
-FIXXREF = $(srcdir)/xsl/fixxref.py
-HTML_STYLE = $(srcdir)/xsl/ref-html-style.xsl
-
XML_FILES = \
reference/nautilus-python-ref.xml \
reference/nautilus-python-overview.xml \
@@ -27,76 +24,58 @@ XML_FILES = \
reference/nautilus-python-operation-result.xml
HTMLdir = $(datadir)/gtk-doc/html/nautilus-python
-HTML_FILES = \
- html/index.html \
- html/index.sgml \
- html/nautilus-python-overview.html \
- html/nautilus-python-overview-example.html \
- html/nautilus-python-overview-methods.html \
- html/nautilus-python-class-reference.html \
- html/nautilus-python-provider-reference.html \
- html/class-nautilus-python-column.html \
- html/class-nautilus-python-column-provider.html \
- html/class-nautilus-python-menu.html \
- html/class-nautilus-python-menu-item.html \
- html/class-nautilus-python-menu-provider.html \
- html/class-nautilus-python-property-page.html \
- html/class-nautilus-python-property-page-provider.html \
- html/class-nautilus-python-location-widget-provider.html \
- html/class-nautilus-python-file-info.html \
- html/class-nautilus-python-info-provider.html \
- html/nautilus-python-enum-reference.html \
- html/enum-nautilus-python-operation-result.html \
- html/nautilus-python.devhelp
-HTML_DATA = $(HTMLFILES)
-
-XSL_FILES = \
- xsl/common.xsl \
- xsl/devhelp.xsl \
- xsl/html.xsl \
- xsl/pdf-style.xsl \
- xsl/pdf.xsl \
- xsl/style.css
-XSL_DATA = $(XSL_FILES) $(FIXXREF)
-XSLdir = $(BUILDDIR)/xsl
-
-CSS_FILES = xsl/style.css
-CSSdir = $(HTMLdir)
-CSS_DATA = $(CSS_FILES)
+HTML_DATA = \
+ index.html \
+ index.sgml \
+ nautilus-python-overview.html \
+ nautilus-python-overview-example.html \
+ nautilus-python-overview-methods.html \
+ nautilus-python-class-reference.html \
+ nautilus-python-provider-reference.html \
+ class-nautilus-python-column.html \
+ class-nautilus-python-column-provider.html \
+ class-nautilus-python-menu.html \
+ class-nautilus-python-menu-item.html \
+ class-nautilus-python-menu-provider.html \
+ class-nautilus-python-property-page.html \
+ class-nautilus-python-property-page-provider.html \
+ class-nautilus-python-location-widget-provider.html \
+ class-nautilus-python-file-info.html \
+ class-nautilus-python-info-provider.html \
+ nautilus-python-enum-reference.html \
+ enum-nautilus-python-operation-result.html \
+ nautilus-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_FILES)
+ $(HTML_DATA)
CLEANFILES = \
nautilus-python-ref.* \
reference/builddate.xml \
- $(HTML_FILES)
+ $(HTML_DATA)
EXTRA_DIST = \
$(XML_FILES) \
- $(XSL_FILES) \
- $(FIXXREF) \
- $(HTML_STYLE)
+ $(HTML_DATA)
REFERENCE_DEPS = \
reference \
- $(XML_FILES) \
- $(XSL_FILES) \
- $(FIXXREF)
+ $(XML_FILES)
if ENABLE_GTK_DOC
reference/builddate.xml: $(REFERENCE_DEPS)
$(PYTHON) -c 'import datetime; print datetime.date.today()' > $@
-$(HTML_FILES): $(REFERENCE_DEPS)
- xsltproc --nonet --xinclude -o $(BUILDDIR)/html/ \
- --path $(BUILDDIR)/reference:$(srcdir)/reference \
- --stringparam gtkdoc.bookname "nautilus-python" \
- --stringparam gtkdoc.version ${REF_VERSION} \
- $(HTML_STYLE) $(srcdir)/reference/nautilus-python-ref.xml
- $(FIXXREF) -i xsl $(BUILDDIR)/html
+$(HTML_DATA): $(REFERENCE_DEPS) reference/builddate.xml
+ $(GTKDOC_MKHTML) \
+ nautilus-python $(srcdir)/reference/nautilus-python-ref.xml \
+ --path $(BUILDDIR)/reference:$(srcdir)/reference
touch $@
-
+
endif
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]