summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* update some doc copyright dates/formattingWilliam Deegan2020-07-044-8/+12
|
* Updated generated doc files for 4.0.0William Deegan2020-07-043-27/+47
|
* Merge pull request #3730 from mwichmann/mavc-tool-docWilliam Deegan2020-07-041-1/+1
|\ | | | | Updates to doc for MSVC construction vars
| * [PR #3730] fix doc syntax errors [skip appveyor]Mats Wichmann2020-07-031-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #3734 from bdbaddog/restore_scons_localWilliam Deegan2020-07-043-5/+5
|\ \ | |/ |/| Add sepearat pypi README-package.rst for pypi's long description text
| * Add sepearat pypi README-package.rst for pypi's long description textWilliam Deegan2020-07-043-5/+5
| |
* | sconsign man: fix missing para markup [ci skip]Mats Wichmann2020-07-021-0/+2
| | | | | | | | | | | | | | Earlier change to update SEE ALSO section dropped some required markup. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #3727 from mwichmann/sconsign-manWilliam Deegan2020-07-011-49/+88
|\ \ | | | | | | Apply formatting preferences to sconsign man
| * | Apply formatting preferences to sconsign man [ci skip]Mats Wichmann2020-07-011-49/+88
| | | | | | | | | | | | | | | | | | | | | The sconsign manpage hasn't received the same update to formatting styles as scons, do that. Minimal content change. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Merge pull request #3712 from bdbaddog/restore_scons_localWilliam Deegan2020-07-016-263/+260
|\ \ \ | |/ / |/| / | |/ Re-implement scons-local build + travis ci updates for build
| * API doc builds working now. Generating SCons/__versioninfo.py but not yet ↵William Deegan2020-06-303-5/+13
| | | | | | | | 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-293-54/+28
| | | | | | | | tarball for distribution
| * [appveyor skip] fix ulink vs link xml syntaxWilliam Deegan2020-06-231-4/+4
| |
| * [appveyor skip] fix ulink vs link xml syntaxWilliam Deegan2020-06-234-174/+179
| |
* | Tweak userguide wording on cachedir [ci skip]Mats Wichmann2020-06-301-20/+38
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #3713 from mwichmann/man-actionsWilliam Deegan2020-06-271-83/+84
|\ \ | | | | | | A bit of tweaking on Action Objects in manpage
| * | [PR #3713] tweak manpage per review commentsMats Wichmann2020-06-251-4/+12
| | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * | A bit of tweaking on Action Objects in manpage [ci skip]Mats Wichmann2020-06-241-82/+75
| |/ | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | Add a new chapter on external tools to User Guide [ci skip]Mats Wichmann2020-06-245-82/+184
|/ | | | | | Initial content is the compilation_db material Signed-off-by: Mats Wichmann <mats@linux.com>
* Fixed Docbook Tool and updated its tests.Dirk Baechle2020-06-211-1/+1
|
* Updated generated doc files and user manual.Dirk Baechle2020-06-206-1183/+1175
|
* Fix docbook 4.5 vs 5 usage [ci skip]Mats Wichmann2020-06-173-9/+7
| | | | | | | | | | | | | | | | Recent changes introduced the use of the Docbook 5 syntax for external links (<link xlink:href="https://www.example.com"/>), which works okay for the doc build, but breaks the internal tools which do formal validation against the scons-modified docbook DTD ("sconsdoc") because sconsdoc is a modification of Docbook 4.5 thus pinning us to that version. xlink was a Docbook 5 introduction to use more standard W3C syntax for the links (xlink is a W3C spec of its own). Back off this new usage: go back to the old usage pattern (<ulink url="https://www.example.com">), because trying to uplift sconsdoc looks a fairly substantial task. Signed-off-by: Mats Wichmann <mats@linux.com>
* Documentation updates in perparation for 4.0 [ci skip]Mats Wichmann2020-06-10240-268/+369
| | | | | | | | | | | | | * 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>
* Merge pull request #3641 from mwichmann/wip-sphinx-apidocsWilliam Deegan2020-06-0911-0/+796
|\ | | | | Initial logic for Sphinx build of API docs - replacing epydoc
| * 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-3015-0/+1876
| | | | | | | | | | | | | | | | | | 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>
* | Merge pull request #3662 from bdbaddog/add_compilation_dbWilliam Deegan2020-06-083-0/+68
|\ \ | | | | | | Add compilation db for use by clang tools and cquery (fix issue #3355)
| * | [ci skip] updates based on mwichmann's review of the PRWilliam Deegan2020-06-071-3/+2
| | |
| * | change CompilationDatabase from psuedo builder to builder. Add emitter to ↵William Deegan2020-06-061-0/+15
| | | | | | | | | | | | clear source and set default target as 'compile_commands.json'.
| * | [ci skip] a little formatting changeWilliam Deegan2020-05-291-24/+33
| | |
| * | [ci skip] Add initial section for Users Guide misc section for compilation ↵William Deegan2020-05-271-0/+42
| | | | | | | | | | | | database
| * | add commented out XSLTFLAGS info which may enable creating PDF bookmarksWilliam Deegan2020-05-271-0/+1
| | |
| * | add comment to indicate which sections are appendixWilliam Deegan2020-05-271-0/+2
| | |
* | | Fix userguide entity typo [ci skip]Mats Wichmann2020-06-041-1/+1
| | | | | | | | | | | | | | | | | | &f-GetOption; was not properly camelcased in recent commit. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | [ci skip] fix typo in markupWilliam Deegan2020-06-041-1/+1
| | |
* | | [PR #3682] drop one more env var $ introducer [ci skip]Mats Wichmann2020-06-031-1/+1
| | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | | User Guide: update markup for cmdline section [ci skip]Mats Wichmann2020-06-023-498/+567
| | | | | | | | | | | | | | | | | | | | | | | | | | | Update the markup in the cmdline chapter. Also checked in two generated docs which were changed by a couple of earlier changesets. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Merge pull request #3676 from mwichmann/manpage-extendingWilliam Deegan2020-06-011-161/+112
|\ \ \ | | | | | | | | Update manpage Extending section
| * | | [PR #3676] fix doc typo detected by sider [ci skip]Mats Wichmann2020-05-311-1/+2
| | | | | | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * | | Update manpage Extending section [ci skip]Mats Wichmann2020-05-311-162/+114
| | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | Extending SCons: this is mainly syntax: adding/adjusting markup, reformatting code examples, adding the word "Example:" in a few places, moving a paragraph outside a list since it applies to the whole list, not to the last item of the list. A list is reformatted to a <simplelist> for a shorter layout. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Merge pull request #3677 from mwichmann/manpage-examplesWilliam Deegan2020-06-011-99/+119
|\ \ \ | | | | | | | | Update manpage Examples section
| * | | Update manpage Examples section [ci skip]Mats Wichmann2020-05-311-99/+119
| |/ / | | | | | | | | | | | | | | | | | | Examples: mainly syntax: adding/adjusting markup, reformatting code examples, etc. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Merge pull request #3678 from mwichmann/manpage-configfileWilliam Deegan2020-05-311-129/+147
|\ \ \ | | | | | | | | Update manpage Configuration File section
| * | | Update manpage Configuration File section [ci skip]Mats Wichmann2020-05-311-129/+147
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | CONFIGURATION FILE REFERENCE: markup added/updated, examples reformatted. A chunk of text followed the included "GENERATED CONSTRUCTION VARIABLE DESCRIPTIONS" which describes how to access consvars, this was moved before the inclusion for better flow. A bit was added to the final paragraph before that inclusion to remind that actual consvars are based on which tools were actually able to initialize. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Update manpage Options section [ci skip]Mats Wichmann2020-05-311-58/+71
|/ / | | | | | | | | | | | | OPTIONS: add/change markup. A few comments modified on CacheDir usage, and on Help. Dropped a reference to SCCS/RCS retrieval. Signed-off-by: Mats Wichmann <mats@linux.com>
generated by cgit v0.12 at 2025-04-12 14:10:18 (GMT)