summaryrefslogtreecommitdiff
path: root/tests/test_ext_apidoc.py
Commit message (Collapse)AuthorAgeFilesLines
* Prefer ``@pytest.fixture()``Adam Turner2023-02-181-1/+1
|
* Fix COM812Adam Turner2023-02-181-1/+1
|
* Run the ``pyupgrade`` toolAdam Turner2022-10-171-2/+2
|
* RefactorAdam Turner2022-05-021-6/+4
|
* Remove always-false branchesAdam Turner2022-05-021-4/+1
|
* Merge branch '5.x' into fix-warningsAdam Turner2022-05-021-0/+29
|\ | | | | | | | | # Conflicts: # tests/test_search.py
| * Add test for duplicated submodules in `sphinx.ext.apidoc`Adam Turner2022-05-011-0/+29
| |
* | `.write_text(...)` -> `.write_text(..., encoding='utf8')`Adam Turner2022-04-271-16/+16
| |
* | `.read_text()` -> `.read_text(encoding='utf8')`Adam Turner2022-04-271-13/+13
| |
* | Specify encodingAdam Turner2022-04-221-18/+18
|/
* Collapse single line docstringsAdam Turner2022-02-201-2/+1
|
* Remove copyright and licence fieldsAdam Turner2022-02-201-3/+0
|
* Fix module docstring indentationAdam Turner2022-02-201-2/+2
|
* Fix module docstring first lineAdam Turner2022-02-201-2/+1
|
* Remove module titles in docstringsAdam Turner2022-02-191-3/+0
|
* A happy new year!Takeshi KOMIYA2022-01-011-1/+1
|
* Fix #9608: apidoc: module is not described if implicit namespace packageTakeshi KOMIYA2021-09-041-0/+2
| | | | | To make implicit namespace packages referencable, this outputs empty module definitions for them.
* Fix #8727: apidoc: namespace module file is not generated if no submodulesTakeshi KOMIYA2021-01-231-0/+8
| | | | | | sphinx-apidoc should generate a namespace module file when `--implicit-namespace` option given. This fixes the case the namespace module has subpackages, but no submodules.
* A happy new year!Takeshi KOMIYA2021-01-011-1/+1
| | | | | | | .. note:: $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \; $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
* Cleaner fix for double trailing whitespace apidocAleksaC2020-07-111-1/+0
|
* Remove double trailing newlines from apidoc testsAleksaC2020-07-101-5/+2
|
* * Updated tests according to latest changes.Sergio Garcia Prado2020-03-151-3/+6
|
* test: Use read_text() and read_bytes()Takeshi KOMIYA2020-02-011-13/+13
|
* Fix #6899: apidoc: private members are not shown even if --private givenTakeshi KOMIYA2020-01-301-1/+3
|
* A happy new year!Takeshi KOMIYA2020-01-011-1/+1
|
* apidoc: Insert newlines between submodulesStephen Finucane2019-06-071-4/+13
| | | | | | | | | | Fix a regression introduced in 2.1.0 where submodules didn't have a newline between them resulting in the following warning: Explicit markup ends without a blank line; unexpected unindent. Signed-off-by: Stephen Finucane <stephen@that.guru> Closes: #6440
* refactor apidoc: Add is_skipped_module()Takeshi KOMIYA2019-05-301-0/+15
|
* apidoc: Use a template for generating package fileTakeshi KOMIYA2019-05-041-0/+166
|
* apidoc: Use a template for generating toc fileTakeshi KOMIYA2019-05-041-0/+18
|
* apidoc: Use a template for generating module fileTakeshi KOMIYA2019-05-041-0/+30
|
* test: Reduce warnings on building test-rootTakeshi KOMIYA2019-02-141-2/+0
| | | | Note: all warnings are tested on test-warnings.
* Remove use of deprecated APIsTakeshi KOMIYA2019-01-031-6/+4
|
* Merge branch '1.8'Takeshi KOMIYA2019-01-021-1/+1
|\
| * A happy new year!Takeshi KOMIYA2019-01-021-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.
* | refactor: Remove u-prefix from stringsTakeshi KOMIYA2018-12-161-8/+8
| |
* | Remove print_function featureTakeshi KOMIYA2018-12-151-2/+0
|/
* Fix flake8 violations on testsTakeshi KOMIYA2018-07-281-2/+0
|
* Fix sphinx.testing uses deprecated pytest API; Node.get_marker(name)Takeshi KOMIYA2018-06-071-1/+4
|
* Closes #4520 - acidic: Subpackage not in toc. The rule of skipping folders ↵Christer Bystrom2018-03-211-1/+66
| | | | 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.
* Fix flake8 violationsTakeshi KOMIYA2018-02-191-1/+0
|
* Fix #4581: apidoc: Excluded modules still includedTakeshi KOMIYA2018-02-111-1/+16
|
* Merge branch 'stable' into 1.7-releaseTakeshi KOMIYA2018-01-281-0/+60
|
* test: Adjust testcase for #3962Takeshi KOMIYA2018-01-071-2/+2
|
* Merge commit '4277eb13315d5649401190df86874b3832ddfa3e'Takeshi KOMIYA2018-01-071-0/+77
|
* Merge branch 'happy_new_year' into masterTakeshi KOMIYA2018-01-011-1/+1
|
* sphinx-apidoc: Convert to argparseStephen Finucane2017-10-091-4/+4
| | | | | | | | | | 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>
* apidoc: Move apidoc to ext/apidocStephen Finucane2017-09-201-0/+190
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>