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/log.txt | |
| 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/log.txt')
| -rw-r--r-- | doc/log.txt | 10 |
1 files changed, 9 insertions, 1 deletions
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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |