diff options
| author | Mats Wichmann <mats@linux.com> | 2024-03-17 14:25:33 (GMT) |
|---|---|---|
| committer | Mats Wichmann <mats@linux.com> | 2024-03-17 14:33:53 (GMT) |
| commit | 084a3da5ce5295fe3566f7788e957c5d16b004d5 (patch) | |
| tree | 3466be01443491d494fb2592a8df8fac25fb6bc6 /site_scons/BuildCommandLine.py | |
| parent | 2c3983f21c2bb76f134f0500020c68e20dae294a (diff) | |
| download | SCons-084a3da5ce5295fe3566f7788e957c5d16b004d5.zip SCons-084a3da5ce5295fe3566f7788e957c5d16b004d5.tar.gz SCons-084a3da5ce5295fe3566f7788e957c5d16b004d5.tar.bz2 | |
Give more control to docs build [skip appveyor]
The documentation build can now selectively disable doing the APIdocs
build (which is slow, and requires Sphinx and some extensions to be
installed); and skip building pdf versions of docs (which requires fop
or equivalent to be installed). Both can be disabled by using a csv:
scons doc SKIP_DOCS=pdf,api
TODO: pdf disabling is only partly working. It does not build the
pdf version of the api docs, but does build pdf manpages and user guide.
The latter are not "installed": there is no build/doc/PDF, but there
are pdfs in the build directory, build/doc/man and build/doc/user.
This is part two of the doc build change (begun in #4492)
Signed-off-by: Mats Wichmann <mats@linux.com>
Diffstat (limited to 'site_scons/BuildCommandLine.py')
| -rw-r--r-- | site_scons/BuildCommandLine.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/site_scons/BuildCommandLine.py b/site_scons/BuildCommandLine.py index d401aed..32e62f3 100644 --- a/site_scons/BuildCommandLine.py +++ b/site_scons/BuildCommandLine.py @@ -77,7 +77,9 @@ class BuildCommandLine: ), ( "SKIP_DOC=", - "Skip building all documents. The default is False (build docs)" + "Skip building documents. The value can be 'pdf', 'api', " + "''all' or 'none'. A comma-separated list is also allowed. " + "The default is 'none' (build all docs)" ), ] |