summaryrefslogtreecommitdiff
path: root/sphinx/apidoc.py
Commit message (Collapse)AuthorAgeFilesLines
* Drop APIs deprecated in 2.0Takeshi KOMIYA2018-09-031-41/+0
|
* Merge branch '1.7'Takeshi KOMIYA2018-06-211-5/+5
|\
| * Fix #5104: apidoc: Interface of ``sphinx.apidoc:main()`` has changedTakeshi KOMIYA2018-06-181-3/+3
| |
* | Drop typing.TYPE_CHECKINGTakeshi KOMIYA2018-03-261-2/+2
| |
* | Use typing.TYPE_CHECKINGTakeshi KOMIYA2018-02-191-3/+2
| |
* | Merge branch '1.7'Takeshi KOMIYA2018-02-191-0/+1
|\ \ | |/
| * Fix #4615: The argument of ``sphinx.build`` has been changed in 1.7.0Takeshi KOMIYA2018-02-161-0/+1
| |
* | Update type annotationsTakeshi KOMIYA2018-02-041-0/+7
|/
* Merge branch 'happy_new_year' into masterTakeshi KOMIYA2018-01-011-1/+1
|\
| * A happy new year!Takeshi KOMIYA2018-01-011-1/+1
| |
| * Use ensuredir() instead of os.makedirs() to fix race conditionsMichał Górny2017-12-161-4/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Use the ensuredir() function consistently across Sphinx code to avoid race conditions e.g. when multiple Sphinx instances attempt to create the same output directory. The ensuredir() function that was already present in sphinx.util.osutil correctly catches EEXIST exception that occurs if the specified directory already exists (i.e. it was created between the call to os.path.isdir() and os.makedirs() that follows it). While at it, remove redundant os.path.isdir() calls when they only guarded the os.makedirs() call, and replace mkdir_p() which had pretty much the same purpose, except for being prone to race conditions. I did not modify testing-related code as race conditions mostly affect real applications and not the test environment. Fix #4281: Race conditions when creating output directory
* | apidoc: Move apidoc to ext/apidocStephen Finucane2017-09-201-421/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-4/+5
| | | | | | | | correctly
* | Don't ignore first argument to sphinx.apidoc.mainAdam J. Stewart2017-04-251-2/+2
|/
* Merge branch 'stable'Takeshi KOMIYA2017-03-261-5/+8
|\
| * Year++Takeshi KOMIYA2017-03-261-1/+1
| |
| * Fix issues with trailing underscores in heading namesEric Wieser2017-03-231-2/+5
| | | | | | | | Fixes #1451, using the approach in 8d96c90fc6ca7805ba7a8e8fd80cc74da7caf46c
* | Upgrade to mypy-0.5Takeshi KOMIYA2017-03-031-2/+3
| |
* | Merge pull request #3323 from gbaier/apidoc_extensionsTakeshi KOMIYA2017-01-121-0/+10
|\ \ | | | | | | apidoc takes extension options
| * | moved import to top of fileGerald Baier2017-01-121-1/+1
| | |
| * | implementing PR commentsGerald Baier2017-01-121-2/+2
| | |
| * | apidoc takes extension optionsGerald Baier2017-01-111-0/+10
| | |
* | | Merge branch 'stable'Takeshi KOMIYA2017-01-121-2/+2
|\ \ \ | |/ / |/| / | |/
| * Fix flake8 violationsTakeshi KOMIYA2017-01-121-2/+2
| |
* | Add type-check annotations to sphinx.*Takeshi KOMIYA2016-11-161-4/+20
|/
* Merge branch 'stable' into 1.5-releaseTakeshi KOMIYA2016-11-161-0/+1
|\
| * insert blank line(s) to adapt latest flake8/pycodestyleshimizukawa2016-11-161-0/+1
| |
* | Closes #930: sphinx-apidoc allow wildcards for excluding paths.shimizukawa2016-11-061-4/+5
| |
* | Sphinx apidoc does not process PEP-0420 implicit namespacesArcadiy Ivanov2016-09-151-14/+29
| | | | | | | | fixes #2949, connected to #2949
* | Fix #2892: Added ``-a`` (``--append-syspath``) option to `sphinx-apidoc`Takeshi KOMIYA2016-08-241-0/+5
| |
* | Merge branch 'master' into HEADTakeshi KOMIYA2016-08-221-1/+15
|\ \
| * | Refactor code using ``with`` syntaxTakeshi KOMIYA2016-05-261-4/+1
| |/
| * Merge branch 'stable'Georg Brandl2016-01-141-1/+1
| |\
| | * Obligatory copyright update.Georg Brandl2016-01-141-1/+1
| | |
| * | Merge with '87998df9cbef2380345d436121e6bca43345d2bd' on stableshimizukawa2016-01-101-0/+10
| |\ \ | | |/ | | | | | | | | | Conflicts: tests/test_build_latex.py
| | * Fix broken in py3Takeshi KOMIYA2015-12-251-14/+13
| | |
| | * Fix #2040: UnicodeDecodeError in sphinx-apidoc when author contains ↵Takeshi KOMIYA2015-12-251-4/+15
| | | | | | | | | | | | non-ascii characters
| * | allow apidoc using 'python -m sphinx.apidoc'Paul Kienzle2015-06-041-0/+4
| |/
* | Use FileAvoidWrite in apidocGregory Szorc2015-06-021-5/+2
|/ | | | | | | | | | | | Previously, sphinx-apidoc would always write files, even if the auto-generated content was identical. This would bump the mtime and cause the file to be re-read and generated on the next build invocation. After this patch, the files are not written unless content has changed. In a contrived example using `sphinx-apidoc` to regenerate documentation for CPython's Lib/ directory, this patch reduced the number of "updated" source files from 257 to 2. Execution time of `sphinx-build` without parallelism decreased from ~12.5s to ~4.5s.
* refactoring. path.abspath will call path.normpath.shimizukawa2015-04-051-4/+3
|
* Fixes #1823: '.' as <module_path> for sphinx-apidoc cause an unfriendly ↵shimizukawa2015-04-051-1/+1
| | | | error. Now '.' is converted to absolute path automatically.
* Support PEP-440 version spec for developers.shimizukawa2015-03-141-2/+2
|
* pep8 fixesGeorg Brandl2015-03-081-4/+4
|
* Added insertion of todo_include_todos config option.Ian Lee2015-02-071-0/+1
| | | | Set to True when we enable 'ext_todo' during the quickstart process.
* Merge branch 'stable'Georg Brandl2015-01-031-1/+1
|\
| * all: update copyrightGeorg Brandl2015-01-031-1/+1
| |
* | Closes #1593: fix quickstart -F.Georg Brandl2014-10-201-0/+1
| |
* | Minor PEP8 cleanup.Georg Brandl2014-09-211-4/+4
| |
* | merge with stableTakayuki Shimizukawa2014-08-121-0/+7
|\ \ | |/
| * `sphinx-apidoc` command now have a `--version` option to show version ↵Takayuki Shimizukawa2014-07-251-0/+7
| | | | | | | | information and exit. closes #1518
View Lorry Controller Status