summaryrefslogtreecommitdiffstats
path: root/doc/SConscript
Commit message (Collapse)AuthorAgeFilesLines
* Give more control to docs build [skip appveyor]Mats Wichmann2024-03-171-52/+100
| | | | | | | | | | | | | | | | | | 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>
* Tweak documentation build [skip appveyor]Mats Wichmann2024-03-141-50/+36
| | | | | | | | | | | | Simplify the handling of info for each doc, avoid constructs like docs[doc][DOCDEPENDS].append(btarget) by unpacking the doc values. This is part 1 of a small rework. Signed-off-by: Mats Wichmann <mats@linux.com>
* Cleanup the SCons build a bitMats Wichmann2023-07-191-133/+212
| | | | | | | | | | | | | | | | | | | | | | * Removes the old bootstrap.py file. The still-used manifest parser is moved inline into doc/SConscript * Some reformatting and license text updates, as well as fstringinfying. * Help text is modified, adding the recent zipapp option, and indent changes let more stuff fit on the screen. * Aliases added for most of the build targets listed in the help msg. The ones now listed all work when given as cli targets, except the the two full source balls: scons: *** Do not know how to make File target `src-tar-gz' (/home/mats/github/scons/src-tar-gz). Stop. scons: *** Do not know how to make File target `src-zip' (/home/mats/github/scons/src-zip). Stop. Should these two be removed from the listing? I think we get the former directly from github, and the latter hasn't been around for a while. Fixes #4341 Signed-off-by: Mats Wichmann <mats@linux.com>
* removed doc/user/copyright.xml the markup is moved ot doc/user/main.xmlWilliam Deegan2021-07-191-4/+5
|
* misc updates to man/users guide copyright formatting. Minor updates to ↵William Deegan2021-07-181-2/+3
| | | | update-release-info to use 'Released: <date here>' instead of range of years.
* API doc builds working now. Generating SCons/__versioninfo.py but not yet ↵William Deegan2020-06-301-3/+4
| | | | using it
* Fix formattingWilliam Deegan2020-06-291-44/+54
|
* Update logic to generate scons-api docs and include in the scons-docs ↵William Deegan2020-06-291-50/+17
| | | | tarball for distribution
* Fixed Docbook Tool and updated its tests.Dirk Baechle2020-06-211-1/+1
|
* [WIP] adjust docbuild for moved src [ci skip]Mats Wichmann2020-05-101-4/+4
| | | | | | | src/engine/SCons moved to SCons, affects wired in paths in documentation, and doc building scripts Signed-off-by: Mats Wichmann <mats@linux.com>
* Disable generating API docs for now epydoc is unmaintained and (?) not ↵William Deegan2020-04-091-1/+1
| | | | working with py3. Need to switch to sphinx(?)
* Fix doc sconscriptWilliam Deegan2020-04-091-1/+1
|
* comment out packaging part of buildWilliam Deegan2020-04-091-1/+1
|
* First pass of refactor. Moved command line argument processing into ↵William Deegan2020-04-091-3/+3
| | | | site_scons/BuildCommandLine.py. Sorted out all changes caused by that.
* add SKIP_DOC= variable to enable disabling buildign documents. Moved epydoc ↵William Deegan2020-04-091-120/+54
| | | | setup into site_scons/epydoc.py
* rm-py2: Remove "from __future__" from more placesMats Wichmann2020-02-201-2/+0
| | | | | | | | | | | | | | | A couple of minor reformats along the way, most prominently, in tests, if being edited anyway, make sure the docstring most tests have is actually the docstring (sometimes the __revision__ line came before, which makes the string not be the docstring). Snuck in some minor framework changes that were orphaned when another draft PR was not needed: this almost all docstring changes, the functional part is using casefold instead of lower in a match func - a slightly better approach which is now possible that Py2 compatibility is not needed. Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix some py3.8 warnings in doc SConscriptWilliam Deegan2020-02-171-2/+3
|
* checker fixes: None, trailing ws, list initMats Wichmann2019-12-211-1/+1
| | | | | | | | | | | checker-suggested fixes: Mostly, fix remaining instances of comparing none without "is" Some trailing whitespace on lines A couple of instances of list init followed immediately by several appends, turned into a single list init Some double comparisons turned into a single expression Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix problem where API doc gen misses some filesMats Wichmann2019-02-061-8/+9
| | | | | | | | | | | In doc/SConscript, the function in bootstrap.py to parse a manifest was called with an scons path (#src/engine) but bootstrap does not run in an scons context, it is run via subprocess.Popen. Preprocess the path. Along the way, change the function to open the file itself instead of being passed a list already read from the file, update the comment, and clean some whitespace issues. Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix logic to include Platfrom/virtualenv.py in doc buildWilliam Deegan2018-12-051-1/+3
|
* Allow to override build date with SOURCE_DATE_EPOCHBernhard M. Wiedemann2018-10-151-2/+3
| | | | | | | | | | | in order to make builds reproducible. See https://reproducible-builds.org/ for why this is good and https://reproducible-builds.org/specs/source-date-epoch/ for the definition of this variable. Also consistently use ISO 8601 date format to be understood everywhere. Also use gmtime to be independent of timezone.
* Simplify main SConstruct. Remove deb and rpm and win executable package ↵William Deegan2017-10-041-1/+2
| | | | creation as we're moving to pip install being the main install path.
* Some more print statements to functions.Russel Winder2016-01-011-1/+2
|
* Post merge commit for safety. Building Fortran code works, but tests fail.Russel Winder2015-12-241-65/+105
|\
| * - providing MAN page stubs when not all doc packages for the packaging ↵Dirk Baechle2015-01-181-3/+38
| | | | | | | | | | | | process are installed - fixed refmiscinfo for MAN pages
| * doc/SConscript: Fix build crash when XML toolchain is not installedanatoly techtonik2015-01-111-26/+29
| | | | | | | | by intercepting previously added ImportError from SConsDoc
| * - added import of libxslt binding to DocBook testsDirk Baechle2014-08-311-0/+1
| |
* | Merged default branch into python3-port to keep it up to date.Gary Oberbrunner2014-08-231-33/+47
|\ \ | |/ | | | | | | Hand-updated a few things to keep them python3-safe, and handled several merge conflicts.
| * - improved dependency handling for bootstrap process: the "doc" folder is ↵Dirk Baechle2014-05-271-33/+47
| | | | | | | | now correctly linked to its counterpart in "build/doc"
* | Merged with [default]Stefan Zimmermann2014-03-311-89/+214
|\ \ | |/
| * - re-added TEXT as output format (using lynx, if present)Dirk Baechle2014-03-121-3/+38
| | | | | | | | - now copying the scons.css to the final doc archive, too
| * - improved dependency handling for doc toolchain (no false rebuilds anymore)Dirk Baechle2014-03-111-87/+177
| | | | | | | | | | | | - fixed EPUB builder - corrected anchor style for links in CSS - documents now include chapter in section numbering
* | Merged with [default]Stefan Zimmermann2014-03-311-2/+28
|\ \ | |/
| * - added EPUB as output format for documentation ("user" and "man" targets)Dirk Baechle2013-10-081-2/+28
| |
* | doc/SConscript: Fixed octal literal.Stefan Zimmermann2013-12-271-1/+1
| |
* | Made former 2to3 changes Python 2.7 compatible (or removed unneeded changes).Stefan Zimmermann2014-03-311-12/+13
|/
* - patched setup.py and several MANIFEST files, such that the docbook-xslDirk Baechle2013-05-041-3/+4
| | | | | | folder and all additional documentation sources get packaged properly - added basic support for wildcards and recursive globbing in MANIFEST files - added missing JPG/SVG files
* - relinked the build of all documentation outputs to the bootstrap processDirk Baechle2013-05-031-359/+188
| | | | - corrected the doc folder SConscripts and added XSL and titlepage files where required
* - started to implement new XML toolsDirk Baechle2013-05-031-9/+0
| | | | - prepared introduction of SCons XSD namespace
* Clean up remnants of Optik module which was removed inanatoly techtonik2012-11-221-1/+0
| | | | SCons 0.98 (revision 6661c9ea429f by Steven Knight)
* Warn during doc build if missing toolsGary Oberbrunner2012-08-121-0/+4
|
* API Docs Build: Use epydocs module if command line utility isAnatoly Techtonik2011-06-211-33/+101
| | | | | | | not found in PATH. Actual for Windows, can be refactored later into epydocs builder. HTML only for now. Review: http://codereview.appspot.com/4639061/
* Add the generated function documentation to the User's Guide as an appendix.Steven Knight2010-07-221-1/+4
| | | | | Fixes and refactoring in the bin/scons-proc.py script to support this. Fixes to various parts of the XML input.
* Move the authoritative source for functions from the man page to variousSteven Knight2010-07-211-2/+2
| | | | | | .xml files (some new, some updated) next to the modules that implement them. Generate the man page using the output generated from the .xml file by bin/scons-proc.py.
* http://scons.tigris.org/issues/show_bug.cgi?id=2345Greg Noel2010-04-241-2/+0
| | | | | | | Comb out all code that supported earlier versions of Python. Most such code is in snippets of only a few lines and can be identified by having a Python version string in it. Such snippets add up; this combing pass probably got rid of over 500 lines of code.
* Move 2.0 changes collected in branches/pending back to trunk for furtherGreg Noel2010-03-251-19/+16
| | | | | development. Note that this set of changes is NOT backward-compatible; the trunk no longer works with Python 1.5.2, 2.0, or 2.1.
* Rename the sconsoutput.py script to scons-doc.py, and refactor it toSteven Knight2010-01-151-5/+5
| | | | | support command-line option parsing and generating output on streams other than sys.stdout.
* Issue 2255: Handle scanning of UTF-8 and UTF-16 files. (Greg Spencer)Steven Knight2008-12-121-1/+1
|
* Move jw parser option to the rightLudwig Hähne2008-08-241-2/+2
|
* Issue 2151: Enforce building doc PDF and PS with jadeLudwig Hähne2008-08-241-5/+6
|
generated by cgit v0.12 at 2026-01-13 19:20:45 (GMT)