summaryrefslogtreecommitdiff
path: root/tests/test_apidoc.py
Commit message (Collapse)AuthorAgeFilesLines
* apidoc: Move apidoc to ext/apidocStephen Finucane2017-09-201-190/+0
| | | | | | | | | | | | | | | | | | | | | | | 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>
* Fix #3962: sphinx-apidoc does not recognize implicit namespace packages ↵Takeshi KOMIYA2017-07-291-2/+2
| | | | correctly
* Merge branch 'stable'Takeshi KOMIYA2017-05-161-10/+10
|\
| * refs #3458: add sphinx.testing that are moved from /tests directory.shimizukawa2017-05-141-10/+10
| |
* | Merge pull request #3668 from adamjstewart/fixes/apidoc-main-argvTakeshi KOMIYA2017-05-141-1/+1
|\ \ | |/ |/| Don't ignore first argument passed to sphinx.apidoc.main
| * Fix testsAdam J. Stewart2017-04-251-1/+1
| |
* | Fix flake8 violationsTakeshi KOMIYA2017-05-091-0/+2
|/
* Merge branch 'stable'Takeshi KOMIYA2017-03-261-6/+34
|\
| * Year++Takeshi KOMIYA2017-03-261-1/+1
| |
| * Test whether the escaping is correct by looking at the plaintextEric Wieser2017-03-241-7/+22
| | | | | | | | Otherwise we're just testing that the headers are produced with format_header
| * Move apidoc tests to subfolder, rather than polluting main testEric Wieser2017-03-241-4/+6
| |
| * Fix issues with trailing underscores in heading namesEric Wieser2017-03-231-2/+13
| | | | | | | | Fixes #1451, using the approach in 8d96c90fc6ca7805ba7a8e8fd80cc74da7caf46c
* | implementing PR commentsGerald Baier2017-01-121-5/+0
| |
* | apidoc takes extension optionsGerald Baier2017-01-111-0/+18
|/
* pytest migrationshimizukawa2017-01-041-108/+84
|
* Sphinx apidoc does not process PEP-0420 implicit namespacesArcadiy Ivanov2016-09-151-0/+88
| | | | fixes #2949, connected to #2949
* Obligatory copyright update.Georg Brandl2016-01-141-1/+1
|
* Fix broken in py3Takeshi KOMIYA2015-12-251-4/+11
|
* Fix #2040: UnicodeDecodeError in sphinx-apidoc when author contains ↵Takeshi KOMIYA2015-12-251-0/+34
| | | | non-ascii characters
* Merge branch 'stable'Georg Brandl2015-01-031-1/+1
|
* Add a basic test for sphinx.apidoc.Georg Brandl2014-11-061-0/+42