diff options
author | lloyd <[email protected]> | 2011-04-18 15:32:33 +0000 |
---|---|---|
committer | lloyd <[email protected]> | 2011-04-18 15:32:33 +0000 |
commit | 590ba658562924d3aba0147690c4110d63b4f4ae (patch) | |
tree | 1348f14553fa8d484f2ba5ebdc58ddf6452d198e /doc | |
parent | e62da81415097726b2f8689dadbc645de278eeb6 (diff) |
Integrate building docs using Sphinx and Doxygen into the makefile
proper. Enabled using --use-sphinx and --use-doxygen options, both of
which default to false. If Sphinx isn't enabled, the ReST sources are
copied directly (a case where having a very readable source format
comes in handy...)
The reference manual (either Sphinx processed into HTML, or the raw
source) and the Doxygen output (if enabled) are copied into the doc
directory upon install on Unix. Currently not done on Windows, the
install target is fairly bogus there currently, and hasn't been tested
in some time.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile | 60 | ||||
-rw-r--r-- | doc/log.txt | 10 |
2 files changed, 9 insertions, 61 deletions
diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index e183a36ec..000000000 --- a/doc/Makefile +++ /dev/null @@ -1,60 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -W -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html singlehtml latex latexpdf text man - -help: - @echo "Please use \`make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " singlehtml to make a single large HTML file" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." diff --git a/doc/log.txt b/doc/log.txt index 1d863c88b..d3bc51004 100644 --- a/doc/log.txt +++ b/doc/log.txt @@ -10,7 +10,15 @@ Release Notes Version 1.10.0, Not Yet Released ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - * More updates to the documentation + * Further updates to the documentation + + * New options to ``configure.py`` control what tools are used for + documentation generation. The ``--use-sphinx`` option enables + using Sphinx to convert ReST into HTML; otherwise the ReST sources + are installed directly. If ``--use-doxygen`` is used, Doxygen will + run as well. Documentation generation can be triggered via the + ``docs`` target in the makefile; it will also be installed by + the install target on Unix. Version 1.9.16, 2011-04-11 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |