| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
| |
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
| |
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
For a "package" which has a main piece and submodules, the
main part is now processed before, rather than after, the submodules.
Usally there's introductory material (e.g. in the main module's
docstring) and it's more useful for this to appear at the top of
a page rather than down after all the submodules.
Made some docstring tweaks in two modules where the result didn't
look very good - Debug and PathList. For PathList, Sphinx doesn't
process both a class docstring and its __init__ method's docstring -
you get one of the other, so joined those together.
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
|
|
| |
Notes that tool writers might be part of the audience for API docs.
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* Added docstrings on warning classes and module docstring.
* Move globals to top of file.
* Typing.
* Dropped DeprecatedSourceCodeWarning, last use was removed, with the
feature, for SCons 3.1.2.
* Dropped TaskmasterNeedsExecuteWarning, now enforced by Python via an
abstract base class (unused/unneeded since 4.0.0).
* Dropped DeprecatedMissingSConscriptWarning. This was a transitional
warning, no longer needed; can use MissingSConscriptWarning, which
also is no longer used but is left in in case it might be useful.
* Two in-use warnings added to manpage section on enabling warnings
(cache-cleanup-error, future-reserved-variable).
* Improve unittest a bit.
* Sphinx build set not to show inherited memerber for Warnings -
got ugly exception stuff otherwise.
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Move UtilTests.py from the top level to the Util package directory,
for consistency with the other packages with unittests.
Renamed Util/types.py -> Util/sctypes.py. types is the name of a stdlib
module and it's a bad idea to duplicate it, even though in this case it's
"legal" since the file was not at the top level. (Moving UtilTests.py
actually made this a real problem)
Class Selector is no longer an OrderedDict, it just inherits from dict
as ordering is now preserved and we never used any extra features of
OrderedDict.
Fix API doc build - was missing a good bit of Util since it was split
into a package.
Moved the import-loop warning to the top of __init__.py so it will be
more visible.
Fiddly linting, doc-stringing, etc. Super-fiddly: pylint flags foo, bar
and baz as prohibited variable/function/method names. Actually changed
these in UtilTests.py.
SCons.Errors has been a source of import loops because it imports Util.
Now Util is split, directly import from the Util.sctypes submodule the
two things Errors needs - this may reduce the chance of import problems.
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
$ pyupgrade --py36-plus $(<filelist)
Here's mostly what it's done:
- No more 'stringliteral'.encode('utf-8'): now b'stringliteral'
- No more unicode literals
- the default open mode is 'r', leaves out if default
- some f-string conversions (if shorter)
- catch OSError instead of subclasses
- no more mention of "object"
- generator expression instead of list comp. when safe
- a few tests had a shebang but actually began with blank line
- remove coding: utf-8 comment, per pep 3120 this is the default now
Manually - if a file in test/ was modified, then did the copyright
header conversion.
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |\
| |
| | |
Java scanner don't split JAVACLASSPATH on space
|
| | |
| |
| |
| | |
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |/
|
|
| |
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
| |
by pycharm refactoring
|
| |
|
|
| |
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
| |
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* Be more explicit about napoleon config, and tweak to allow
"Attribute" to be grouped as for "Arguments" (:attr: and :param:
in the numpy style).
* Disable inherited members for the Errors module, because the
exception classes were picking up bits from the Python base
Exception, which has no annotation available.
* Update the introduction.
Experimentally, try the "sphinx-book" theme (we can go back to
sphinx-rtd-theme before pushing if this is disliked).
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
|
|
|
| |
Sphinx is now complaining about not defining a language being illegal.
Defined to 'en'.
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
|
|
|
|
|
|
|
|
| |
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>
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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>
|
| |
|
|
| |
target to include the sphinx config files
|
| |
|
|
| |
using it
|
| |
|
|
| |
tarball for distribution
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
* 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>
|
| |
|
|
|
|
|
|
|
| |
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>
|
| |
|
|
| |
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
| |
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
|
|
| |
autoclasstoc enabled, but not particularly used yet.
Signed-off-by: Mats Wichmann <mats@linux.com>
|
| |
|
|
| |
Signed-off-by: Mats Wichmann <mats@linux.com>
|
|
|
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>
|
