summaryrefslogtreecommitdiffstats
path: root/doc/sphinx
Commit message (Collapse)AuthorAgeFilesLines
* Fix Sphinx config file error [skip appveyor]Mats Wichmann2022-07-301-1/+1
| | | | | | | Sphinx is now complaining about not defining a language being illegal. Defined to 'en'. Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix rst2pdf/Sphinx problem a better wayMats Wichmann2022-01-161-0/+4
| | | | | | | | | | | | Our Sphinx config specifies the use of rst2pdf: extensions = [ ... 'rst2pdf.pdfbuilder', ... As of 0.99 we apparently need to declare a pdf stylesheet, even though we don't knowingly use that style. With that change, unpin rst2pdf again. Also upgrade lxml, leaving it pinned to a version with a comment why. Signed-off-by: Mats Wichmann <mats@linux.com>
* Update copyright date in sphinx config fileWilliam Deegan2021-07-241-1/+1
|
* Some small doc fiddles [ci skip]Mats Wichmann2021-01-211-4/+5
| | | | | | | | | | | | | | | | * Use os.environ.copy() in examples - better not to get the Python proxy class that is os.environ, and instead a real dict. * Fix spelling on a python dict method: set_default -> setdefault * Update some wording on prepending in the user guide (where it still said "append to the beginning") * Change the rather oblique note in the recently modified section on Append of values to CPPDEFINES with something more explicit. * And, modify the sphinx config to get the version from SCons rather than hardcoding. Fixes #3867 Signed-off-by: Mats Wichmann <mats@linux.com>
* update API doc version to 4.1.0 and add some more dependencies on the api ↵4.1.0William Deegan2021-01-191-2/+2
| | | | target to include the sphinx config files
* API doc builds working now. Generating SCons/__versioninfo.py but not yet ↵William Deegan2020-06-301-1/+8
| | | | using it
* Update logic to generate scons-api docs and include in the scons-docs ↵William Deegan2020-06-291-1/+1
| | | | tarball for distribution
* Documentation updates in perparation for 4.0 [ci skip]Mats Wichmann2020-06-101-5/+9
| | | | | | | | | | | | | * Switch API docs to readthedocs theme * Add links in manpage SEE ALSO to external websites. These are not just live, but also listed out (Linux manpages won't have the hyperlinks) * Links use docbook5 xlink:href instead of deprecated (claimed to be removed, but apparently not) ulink syntax * Comment out manpage Examples section, and leave a pointer to scons-cookbook.readthedocs.io instead * Regenerate everything, mainly to pick up compilation_db stuff. Signed-off-by: Mats Wichmann <mats@linux.com>
* sphinx build: drop special members [ci skip]Mats Wichmann2020-05-302-2/+11
| | | | | | | | | Opinion time - when special members are included in the docs, the output isn't really readable, it's too cluttered. Don't seem to be able to get the autoclasstoc stuff working, which was supposed to help with that. Signed-off-by: Mats Wichmann <mats@linux.com>
* More sphinx build tweaks [ci skip]Mats Wichmann2020-05-301-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* A bit more sphinx docbuild tweaking [ci skip]Mats Wichmann2020-05-302-17/+2
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Update sphinx build, add autoclasstoc [ci skip]Mats Wichmann2020-05-308-1096/+22
| | | | | | autoclasstoc enabled, but not particularly used yet. Signed-off-by: Mats Wichmann <mats@linux.com>
* Commit the files changed for Sphinx docbuild [ci skip]Mats Wichmann2020-05-301-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* [WIP] Add Sphinx build of API docs [ci skip]Mats Wichmann2020-05-3014-0/+1856
First cut includes a Makefile as generated by Sphinx plumbling, needs to be wired into sconscripts instead. A few regular scons files are updated to address build errors/warnings. Signed-off-by: Mats Wichmann <mats@linux.com>
generated by cgit v0.12 at 2025-04-22 04:35:18 (GMT)