Commit Graph

20 Commits

Author SHA1 Message Date
Doug Hellmann
83f30712b8 fix ext.apidoc to include "empty" packages that contain modules
Commit 2d99648e99 changed the apidoc
extension to ignore packages if the __init__.py file was empty. That
breaks the toctree structure if those packages do contain submodules
and subpackages. This patch adds a check to ensure that empty
__init__.py modules are only skipped if there are no other python
modules in the same directory.

Addresses bug #654

Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-01-23 14:21:03 -05:00
Takeshi KOMIYA
023dad6c66
Merge pull request #4335 from zufallsgenerator/fix-4334-apidoc-toc-inconsistencies
Closes #4334: sphinx-apidoc: References to non-existing files in TOC
2018-01-01 12:03:32 +09:00
Takeshi KOMIYA
2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00
Christer Bystrom
2d99648e99 Closes #4334: sphinx-apidoc: Don't generate references to non-existing files in TOC 2017-12-21 19:06:17 +01:00
shimizukawa
d497d74370 refs #3458: add sphinx.testing that are moved from /tests directory. 2017-05-14 20:47:15 +09:00
Takeshi KOMIYA
56d3458584 Fix flake8 violations 2017-05-09 21:57:36 +09:00
Takeshi KOMIYA
8f9dd64992 Merge branch 'stable' 2017-03-26 11:52:15 +09:00
Takeshi KOMIYA
c57e47e042 Year++ 2017-03-26 11:49:34 +09:00
Eric Wieser
a7397a21fe Test whether the escaping is correct by looking at the plaintext
Otherwise we're just testing that the headers are produced with format_header
2017-03-24 09:53:01 +00:00
Eric Wieser
18d2e2e48b Move apidoc tests to subfolder, rather than polluting main test 2017-03-24 09:51:50 +00:00
Eric Wieser
3e7bee5836 Fix issues with trailing underscores in heading names
Fixes #1451, using the approach in 8d96c90fc6
2017-03-23 12:40:14 +00:00
Gerald Baier
d9ae4ed81e implementing PR comments 2017-01-12 08:52:32 +01:00
Gerald Baier
2402fd7ebe apidoc takes extension options 2017-01-11 11:51:23 +01:00
shimizukawa
5b7d237db3 pytest migration 2017-01-04 00:59:30 +09:00
Arcadiy Ivanov
e34b6823c7
Sphinx apidoc does not process PEP-0420 implicit namespaces
fixes #2949, connected to #2949
2016-09-15 11:49:34 -04:00
Georg Brandl
46d7e8558e Obligatory copyright update. 2016-01-14 22:54:04 +01:00
Takeshi KOMIYA
66ef8102c4 Fix broken in py3 2015-12-25 16:10:37 +09:00
Takeshi KOMIYA
f1cf5d594a Fix #2040: UnicodeDecodeError in sphinx-apidoc when author contains non-ascii characters 2015-12-25 15:52:51 +09:00
Georg Brandl
a23903d8d5 Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Georg Brandl
e6fa449e85 Add a basic test for sphinx.apidoc. 2014-11-06 09:11:20 +01:00