summaryrefslogtreecommitdiffstats
path: root/bin/SConsDoc.py
Commit message (Collapse)AuthorAgeFilesLines
* Use super call instead of direct class callMats Wichmann2022-03-151-1/+1
| | | | | | | | | - super used where direct call to superclass existed - convert a few older-style super() (two-argument) uses - in a few places, where there was an intersection with a super change, variables that override a builtin (e.g. "dict") were renamed. Signed-off-by: Mats Wichmann <mats@linux.com>
* Resolve sider issueWilliam Deegan2021-07-091-2/+2
|
* Updates to docs to indicate experimental statusWilliam Deegan2021-07-081-0/+9
|
* Update docs on documentation [ci skip]Mats Wichmann2020-08-171-9/+27
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Update doc gen to fail more definitively [skip appveyor]Mats Wichmann2020-07-041-6/+6
| | | | | | | | | Now the scons "product" build (including generating and building docs) is done in CI, it's useful to fail more distinctly on xml problems. Modify scripts to do that, and do a bit of reformatting along the way. Signed-off-by: Mats Wichmann <mats@linux.com>
* Replaced 'bare excepts', now catching Exception.Dirk Baechle2020-06-201-6/+0
|
* Fixed Sets/Uses links in generated doc files.Dirk Baechle2020-06-201-8/+9
|
* First set of changes, started to rip out libxslt2.Dirk Baechle2020-06-191-416/+155
|
* Merge pull request #3662 from bdbaddog/add_compilation_dbWilliam Deegan2020-06-081-0/+1
|\ | | | | Add compilation db for use by clang tools and cquery (fix issue #3355)
| * Updates to doc. Still WIPWilliam Deegan2020-05-191-0/+1
| |
* | classes no longer explicitly inherit from objectMats Wichmann2020-05-241-6/+6
|/ | | | | | In Python3 this is the default. Signed-off-by: Mats Wichmann <mats@linux.com>
* [ci skip] Speedup xml validation called by bin/docs-update-generated.py by ↵William Deegan2020-04-221-3/+7
| | | | caching parsed docbook schema. Yields approx 60x speedup
* Address github review notes and sider issuesWilliam Deegan2020-04-111-1/+2
|
* Remove python27 codeWilliam Deegan2020-04-091-49/+19
|
* Add highlighting to funcs/builders [ci skip]Mats Wichmann2020-04-081-9/+33
| | | | | | | | | | | | | | | | | | | | | | | | | | When generating documentation from SConsXML markup, add some markup to match the Python doc style better. In pseudo-markup, we will now get: <bold>foo</bold>(args) <italic>env</italic>.<bold>foo</bold>(args) That is, the function name is highlighted, and for the environment method, env looks like a variable (which it is), rather than the literal name env. The methods to create an element now take keyword args, so they can pass them on to the etree.Element method, which understands an attribute keyword we need for one of these changes. Added a method to create a SubElement, which makes usage clearer. To complement the *Text methods, *Tail methods were added to set/get the .tail attribute of a node. This change is to the tools only, and affects the result of doing "python bin/docs-update-generated.py". Signed-off-by: Mats Wichmann <mats@linux.com>
* Remove obsolete scripts. Remove py27 supportWilliam Deegan2020-03-211-3/+0
|
* [PR #3583] review comment: flag cElementTree use [ci skip]Mats Wichmann2020-03-151-0/+1
| | | | | | | | | cElementTree is deprecated in Py3 series, leave a TODO. Don't remove just yet, right now building the generated files may have problems in Py3, so leave ability to use Py2 for that (see issue #3580) Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix the packagers table again. [ci skip]Mats Wichmann2020-03-131-11/+1
| | | | | | | | | Trying yet another layout to make it look better. Minor tweaks to the doc production tools - dropping some very old usage (pre-Python-2.5). Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3343] fix review comments [ci skip]Mats Wichmann2019-12-051-4/+9
| | | | | | | | | | get importlib magic number from util sider complaints about unicode usage sider complaint about subprocess return value unused sider complaint about shutil import unused (it is used, but inside a big string that is written to a file to be executed) Signed-off-by: Mats Wichmann <mats@linux.com>
* Improve building of docs using Py3 [ci skip]Mats Wichmann2019-12-051-82/+129
| | | | | | | | | | | | | | | | | | | | * context managers on file r/w + use shutil.copy where it makes sense. * lxml wants (demands?) that xml files be processed as bytes * for the phase where we gen the entity files, read as text anyway * Need to solve a problem where the generated xml is putting the \n in literally, not evaluating it. * Fix some examples broken for py3 * Fix more octal constant instances * Cleanups suggested by PyCharm: staticmethods, two blanks before class definition, others. This addresses issues called out in #3300, but is not a complete solution because the actual doc build step still fails with the epydoc failures (which aren't directly because of Py3; epydoc build doesn't work any better on my system with Py3, even with the forked version with patches). Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix some regexes for Python 3.8 complaintsMats Wichmann2019-05-131-2/+2
| | | | | | | | | | | Regexes that contained unescaped backslashes and were not listed in raw string form caused one more test failure when Python 3.8 was experimentally turned on in the Travis CI build. Also one utility script had the same, not affecting tests - found through inspection. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PY 3.8] test fixes for file closings, rawstringsMats Wichmann2019-04-251-90/+82
| | | | | | | On a linux host (missing some things that may be on the Travis CI setup), Py3.8a3 now shows 19 fails, 1048 pass, with 84 Warning: messages. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PY 3.8] fix some sider complaints in #3331Mats Wichmann2019-03-301-0/+1
| | | | | | One was "real": had failed to indent a with: block Signed-off-by: Mats Wichmann <mats@linux.com>
* [WIP] [PY 3.8] fix more warningsMats Wichmann2019-03-301-20/+41
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Several locations with simple usage of deprecated "imp" module changed to use "importlib". These match with work in #3159, but this is not a complete implementation of #3159. More regex patterns are changed to be raw strings. Some strings which did not seem appropriate to change to raw strings (e.g. contain embedded tabs, which Python should honor) had backslashes escaped to avoid accidental Python interpretation. Example: '\t<Import Project="$(VCTargetsPath)\\Microsoft.Cpp.targets" />\n' Python 3.8 was Warning \M was an unknown escape. More open().write(), open().read() style usage changed to use context managers so the file is closed. WIP part: even with Python 3.7, the tests which call sconsign.py fail; oddly they do not fail without the patch to compat.py. sconsign.py does an import using imp module (which is what generates the errors) so needs to be updated anyway. It does not quite fit the "simple usage" pattern - can't do a simple relative import since sconsign is normally located elsewhere in the tree than the main scons code body. With this version of the patch, 700 tests now pass with 3.8, and Warning messages reduced to 2800 (current master has 200 pass, 9000 warns) Signed-off-by: Mats Wichmann <mats@linux.com>
* minor improvements in script logicWilliam Deegan2017-11-141-5/+9
|
* When iterating over dict.items(), we do not need a new list.Craig Rodrigues2017-03-121-1/+1
|
* Futurize stage 2 2to3 fixes only.William Blevins2016-09-201-1/+1
|
* Post merge commit for safety. Building Fortran code works, but tests fail.Russel Winder2015-12-241-4/+2
|\
| * SConsDoc.py: Calling sys.exit(-1) in imported library is bad, becauseanatoly techtonik2015-01-111-4/+2
| | | | | | | | it removes the trace who and when imported it.
* | Merged with [default]Stefan Zimmermann2014-03-311-2/+2
|\ \ | |/
| * - added doc editor configuration for XXE5Dirk Baechle2014-01-191-2/+2
| | | | | | | | | | - added missing icons for XXE4 - adapted schema location, such that the validation works properly in SernaFree and XXE
* | More __cmp__ to __eq__ (and __lt__). Resolved some UnboundLocalErrors after ↵Stefan Zimmermann2014-03-311-2/+4
| | | | | | | | except.
* | Made former 2to3 changes Python 2.7 compatible (or removed unneeded changes).Stefan Zimmermann2014-03-311-4/+5
| |
* | Result of raw 2to3 run (2to3-2.7); checkpoint for python3 conversion.Gary Oberbrunner2013-09-221-14/+14
|/
* - fixed bootstrap.py, such that it can be called from an arbitrary working ↵Dirk Baechle2013-05-221-1/+1
| | | | | | directory again - fixed indentation in SConsDoc.py
* New doc toolchain changes:Gary Oberbrunner2013-05-041-9/+18
| | | | | | bin/SConsDoc.py: catch parse exceptions and improve error msgs bin/docs-validate.py: allow testing individual files from cmd line src/engine/SCons/Tool/zip.xml: fix text to validate against DTD
* - switched to different schemaLocation URIDirk Baechle2013-05-031-19/+8
|
* - removed suffix= from 'scons_output_command ' and moved itDirk Baechle2013-05-031-48/+137
| | | | one up in the hierarchy to the 'scons_output' tag
* - corrected xincludes for MAN pagesDirk Baechle2013-05-031-131/+366
| | | | | | - started to work on support for UserGuide examples - added xslt for transforming SCons XSD to Docbook documents - added SConstructs for all documents and titlepage for the UserGuide
* - switched all docs to SCons XSDDirk Baechle2013-05-031-93/+106
|
* - added Docbook Tool to the sourcesDirk Baechle2013-05-031-50/+59
| | | | - added SConstruct for the MAN pages
* - added first version of the SCons XSDDirk Baechle2013-05-031-1/+34
| | | | - rewrote User Guide XML files, such that they are valid against it
* - started to implement new XML toolsDirk Baechle2013-05-031-189/+232
| | | | - prepared introduction of SCons XSD namespace
* vert old-style classes in bin/* scripts to new-style classes.Steven Knight2010-05-201-3/+3
|
* http://scons.tigris.org/issues/show_bug.cgi?id=2345Greg Noel2010-04-241-1/+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.
* http://scons.tigris.org/issues/show_bug.cgi?id=2317Greg Noel2010-04-231-1/+1
| | | | | | Apply the refactorings from the 'dict' fixer, less occurrences that were manually audited to be safe. Also pick up changes in bin/sfsum, a Python file that was not being scanned before.
* http://scons.tigris.org/issues/show_bug.cgi?id=2329Greg Noel2010-03-271-4/+2
| | | | | | | | | | | | | | | Applied a number of idiomatic changes. Uses of the 'sort()' method were converted into calls of 'sorted()' when possible and the sorted() expression was inserted into a subsequent statement whenever that made sense. The statement 'while 1:' was changed to 'while True:'. Names from the 'types' module (e.g., 'types.FooType') were converted to the equivalent build-in type (e.g., 'foo'). Comparisons between types were changed to use 'isinstance()'.
* Move 2.0 changes collected in branches/pending back to trunk for furtherGreg Noel2010-03-251-2/+3
| | | | | 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.
* Handle different signatures for global or env versions of functionsSteven Knight2010-03-081-9/+7
| | | | | by the signature specification from the <scons_function> tag to the <arguments> tag.
* More enhancements for documenting functions:Steven Knight2010-03-041-4/+9
| | | | | | | * Add the support for global="0" and env="0" to SConsDoc.py. * Remove unnecessary .IP lines before '\""" delimiters before the next builder / tool / function entry. * Add support for <variablelist> lists.
generated by cgit v0.12 at 2026-02-12 03:08:26 (GMT)