diff options
| author | Kjell Ahlstedt <kjellahlstedt@gmail.com> | 2021-07-04 18:36:36 +0200 |
|---|---|---|
| committer | Kjell Ahlstedt <kjellahlstedt@gmail.com> | 2021-07-04 18:36:36 +0200 |
| commit | c52a2693b8772c496eaad01eb3b996193b48cc59 (patch) | |
| tree | f0ef9007da5c3e79a40b3bb8fd08d995492b9204 | |
| parent | b43cb23a02fb32a3d9f959b009c7a65e0252b8a4 (diff) | |
| download | sigc++-c52a2693b8772c496eaad01eb3b996193b48cc59.tar.gz | |
docs/manual: Add some formatting when html files are generated
making it slightly more similar to gtkmm-documentation and libxml++.
In Autotools builds, don't distribute the empty manual/README file.
| -rw-r--r-- | docs/doc-manual.am | 15 | ||||
| -rwxr-xr-x | tools/tutorial-custom-cmd.py | 11 |
2 files changed, 23 insertions, 3 deletions
diff --git a/docs/doc-manual.am b/docs/doc-manual.am index 8650987..a7e64a4 100644 --- a/docs/doc-manual.am +++ b/docs/doc-manual.am @@ -20,11 +20,22 @@ DOCBOOK_STYLESHEET ?= http://docbook.sourceforge.net/release/xsl/current/html/ch html_tutorialdir = $(libdocdir)/tutorial/html dist_html_tutorial_DATA = $(sort manual/html/index.html $(call vpath_listall,manual/html/*.html)) -dist_noinst_DATA += manual/README manual/libsigc_manual.xml +dist_noinst_DATA += manual/libsigc_manual.xml DISTCLEANFILES += $(addprefix manual/libsigc_manual.,dvi pdf ps) MAINTAINERCLEANFILES += manual/html/* +# Set the use.id.as.filename param so that we don't use the chapter / section +# number as the filename, otherwise the url will change every time anything is +# re-ordered or inserted in the documentation +xslt_params = $(strip \ + --param toc.section.depth 1 \ + --stringparam chunker.output.indent 'yes' \ + --stringparam chunker.output.encoding 'UTF-8' \ + --stringparam toc.list.type 'ul' \ + --stringparam use.id.as.filename '1' \ + ) + manual_srcfile = $(srcdir)/manual/libsigc_manual.xml # Make sure that the documentation will always have been generated before @@ -34,7 +45,7 @@ reference/html/%: | manual/html/index.html manual/html/index.html: $(manual_srcfile) -$(AM_V_at)rm -f manual/html/* $(AM_V_at)$(MKDIR_P) manual/html - $(AM_V_GEN)xsltproc -o manual/html/ --catalogs '$(DOCBOOK_STYLESHEET)' $(manual_srcfile) + $(AM_V_GEN)xsltproc $(xslt_params) -o manual/html/ --catalogs '$(DOCBOOK_STYLESHEET)' $(manual_srcfile) manual/libsigc_manual.dvi: $(manual_srcfile) $(AM_V_GEN)db2dvi -o manual $(manual_srcfile) diff --git a/tools/tutorial-custom-cmd.py b/tools/tutorial-custom-cmd.py index a99521a..f0a8a18 100755 --- a/tools/tutorial-custom-cmd.py +++ b/tools/tutorial-custom-cmd.py @@ -20,8 +20,17 @@ def html(): input_xml_file = sys.argv[2] output_html_dir = sys.argv[3] + # Set the use.id.as.filename param so that we don't use the chapter / section + # number as the filename, otherwise the url will change every time anything is + # re-ordered or inserted in the documentation. # For a list of available parameters, see http://docbook.sourceforge.net/release/xsl/current/doc/html/ - xslt_params = [] + xslt_params = [ + '--param', 'toc.section.depth', '1', + '--stringparam', 'chunker.output.indent', 'yes', + '--stringparam', 'chunker.output.encoding', 'UTF-8', + '--stringparam', 'toc.list.type', 'ul', + '--stringparam', 'use.id.as.filename', '1', + ] xslt_stylesheet = 'http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl' |