summaryrefslogtreecommitdiff
path: root/sphinx/ext/apidoc.py
Commit message (Collapse)AuthorAgeFilesLines
...
* apidoc: Use a template for generating module fileTakeshi KOMIYA2019-05-041-8/+13
|
* Python-3-only clean ups discovered by pyupgradeJon Dufresne2019-03-171-1/+1
| | | | | | | | | | | | | | https://github.com/asottile/pyupgrade > A tool to automatically upgrade syntax for newer versions of the > language. - Drop u str prefix - Drop base object inheritance - Drop args to super() - Use set literals - Use dict comprehension - Use set comprehension
* Merge branch '1.8'Takeshi KOMIYA2019-01-021-1/+1
|\
| * A happy new year!Takeshi KOMIYA2019-01-021-1/+1
| |
* | Merge remote-tracking branch 'upstream/master' into 5842-apidoc-extensionscocodrips2018-12-261-1/+1
|\ \
| * \ Merge branch '1.8'jfbu2018-12-231-1/+1
| |\ \ | | |/ | | | | | | | | | (Resolved) Conflicts: sphinx/texinputs/sphinxmanual.cls
| | * Fix #5834: apidoc: wrong help for --tocfileTakeshi KOMIYA2018-12-191-1/+1
| | |
* | | Add extensions from mastercocodrips2018-12-261-0/+7
|/ /
* | Merge branch '1.8'Takeshi KOMIYA2018-12-181-1/+1
|\ \ | |/
| * Fix #5724: quickstart: sphinx-quickstart fails when $LC_ALL is emptyTakeshi KOMIYA2018-12-171-1/+1
| |
* | Remove unnecessary encoding cookie from Python source filesJon Dufresne2018-12-161-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | In Python 3, the default encoding of source files is utf-8. The encoding cookie is now unnecessary and redundant so remove it. For more details, see the docs: https://docs.python.org/3/howto/unicode.html#the-string-type > The default encoding for Python source code is UTF-8, so you can > simply include a Unicode character in a string literal ... Includes a fix for the flake8 header checks to stop expecting an encoding cookie.
* | Replace all "unicode" type by "str"Takeshi KOMIYA2018-12-151-14/+13
| |
* | Remove print_function featureTakeshi KOMIYA2018-12-151-2/+0
| |
* | Add sphinx.util.typing:unicode to help mypy-3 migrationTakeshi KOMIYA2018-11-241-0/+1
| |
* | Always prefer dict literals over calls to dict()Jon Dufresne2018-11-131-22/+22
| | | | | | | | | | Dict literals are always slightly faster and are idiomatic modern Python.
* | Remove use of six.binary_typeJon Dufresne2018-11-111-11/+0
| | | | | | | | | | | | Remove type checks for cases that don't apply to Python 3. For remaining uses, use bytes instead
* | Deprecate Python2 compat shim sphinx.util.osutil.walk()Jon Dufresne2018-10-051-2/+2
|/ | | | | Code should use os.walk() instead, which works with either str or bytes. All internal calls use str.
* Fix #5362: apidoc: Add ``--toc`` option to change the filename of ToCTakeshi KOMIYA2018-09-061-3/+5
|
* Merge branch '1.7'Takeshi KOMIYA2018-05-141-2/+2
|\
| * Fix #4932: apidoc: some subpackages is ignored if sibling subpackage ↵Takeshi KOMIYA2018-05-031-2/+2
| | | | | | | | contains underscored module
* | Merge branch '1.7'Takeshi KOMIYA2018-03-211-10/+10
|\ \ | |/
| * apidoc: Fix local variable is not initializedTakeshi KOMIYA2018-03-211-0/+1
| |
| * Closes #4520 - acidic: Subpackage not in toc. The rule of skipping folders ↵Christer Bystrom2018-03-211-10/+9
| | | | | | | | with only an empty __init__.py has been removed. The reason for this is that it was never working consistently in the first place and made the code unnecessary hard to reason about. Tests for the TOC generation have been added, as well as tests for the exclude mechanism since they are coupled. One test (test_ext_apidoc.py::test_exclude) has also been modified to reflect the new behaviour.
* | Merge branch '1.7'Takeshi KOMIYA2018-03-191-1/+1
|\ \ | |/
| * usage strings should not contain "usage:"Jeroen Demeyer2018-03-191-1/+1
| |
* | Merge branch '1.7'Takeshi KOMIYA2018-03-181-2/+2
|\ \ | |/
| * Revert "Use typing.TYPE_CHECKING for typehints"Takeshi KOMIYA2018-03-131-2/+2
| | | | | | | | This reverts commit a073e17537c2aacaac305feadea58d4473ec97f4.
* | Update apidoc.pyLilian Besson2018-03-061-1/+1
| | | | | | See #4712
* | Make sphinx-* commands translatableTakeshi KOMIYA2018-03-031-37/+38
| |
* | Supports i18n console outputTakeshi KOMIYA2018-02-251-1/+6
| |
* | Merge branch '1.7'Takeshi KOMIYA2018-02-181-2/+2
|\ \ | |/
| * Use typing.TYPE_CHECKING for typehintsTakeshi KOMIYA2018-02-141-2/+2
| |
* | Merge branch '1.7'Takeshi KOMIYA2018-02-121-14/+12
|\ \ | |/
| * Fix #4581: apidoc: Excluded modules still includedTakeshi KOMIYA2018-02-111-14/+12
| |
* | Merge branch '1.7-release'Takeshi KOMIYA2018-01-311-1/+2
|\ \ | |/
| * Use flake8-import-orderTakeshi KOMIYA2018-01-281-1/+2
| |
* | Merge branch '1.7-release'Takeshi KOMIYA2018-01-281-1/+12
|\ \ | |/
| * Merge branch 'stable' into 1.7-releaseTakeshi KOMIYA2018-01-281-1/+12
| |
* | Convert in-code HTTP URL's to HTTPS, including examplesKurt McKee2018-01-201-1/+1
|/
* Merge commit '4277eb13315d5649401190df86874b3832ddfa3e'Takeshi KOMIYA2018-01-071-1/+5
|
* A happy new year!Takeshi KOMIYA2018-01-011-1/+1
|
* Merge branch 'stable'jfbu2017-12-181-3/+3
| | | | | | | | | | | | | | | Conflicts: sphinx/apidoc.py sphinx/application.py sphinx/quickstart.py modified: CHANGES modified: doc/config.rst modified: doc/markup/inline.rst modified: sphinx/application.py modified: sphinx/builders/__init__.py modified: sphinx/cmd/quickstart.py modified: sphinx/ext/apidoc.py
* quickstart: Rework how we collect extensionsStephen Finucane2017-12-031-8/+6
| | | | | | | | | | This is a little more flexible than the existing set up and makes maximum use of argparse capabilities. This has the side-effect of no longer including configuration for the 'sphinx.ext.todo' extension when said extension is not enabled. Signed-off-by: Stephen Finucane <stephen@that.guru>
* Fix #4226: apidoc: Generate new style makefile (make-mode)Takeshi KOMIYA2017-11-121-0/+1
|
* sphinx-apidoc: Remove 'normalize_excludes' functionStephen Finucane2017-10-091-7/+1
| | | | | | | This is a one-liner that really doesn't need to be split out, so don't do it. Signed-off-by: Stephen Finucane <stephen@that.guru>
* sphinx-apidoc: Move parser to a separate functionStephen Finucane2017-10-091-3/+9
| | | | | | | | This lets us better reason about what the parser is doing and use tools like 'sphinx-contrib.autoprogram' in our own documentation in the future. Signed-off-by: Stephen Finucane <stephen@that.guru>
* sphinx-apidoc: Convert to argparseStephen Finucane2017-10-091-108/+113
| | | | | | | | | | This is pretty self-explanatory, with most changes coming about as a side-effect of argparse vs. optparse API differences. Lowercase characters are used in help strings, per argparse conventions. Some tests are converted because argparse natively supports unicode. Signed-off-by: Stephen Finucane <stephen@that.guru>
* sphinx-quickstart: Move code to 'sphinx.cmd'Stephen Finucane2017-10-021-2/+2
| | | | | | | | | | | | | | | We're going to move the executable's here (or at least those that part of the core library). The 'sphinx-build' executable was already moved, so lets do 'sphinx-quickstart' next. To avoid breaking packages that are using this feature directly, aliases for the old 'main' method are included. This is based on what Django does [1] and, like Django, will allow us to safely remove the old modules in Sphinx 2.0. [1] https://github.com/django/django/blob/1.11/django/test/runner.py#L688-L695 Signed-off-by: Stephen Finucane <stephen@that.guru>
* apidoc: Move apidoc to ext/apidocStephen Finucane2017-09-201-0/+440
The 'sphinx-apidoc' tool is no longer the only kid on the block when it comes to automatic documentation of Python projects, with the likes of 'sphinx-autoapi' in development [1], and is not really maintained. Given the fact that the tool is tangential to Sphinx's main goal, there isn't really anything that warrants its continue existence as a core module. Signify this by moving the feature to 'ext'. This allows the feature to continue to exist in the package, but indicates that stability might be worse than one would expect from the core library. To avoid breaking packages that are using this feature directly, such as pbr [3], aliases for the old 'main' method are included. This is based on what Django does and, like Django, will allow us to safely remove the old modules in Sphinx 2.0. [1] https://github.com/rtfd/sphinx-autoapi [2] https://github.com/sphinx-doc/sphinx/pull/3485#issuecomment-288081223 [3] https://github.com/django/django/blob/1.11/django/test/runner.py#L688-L695 Signed-off-by: Stephen Finucane <stephen@that.guru>
View Lorry Controller Status