summaryrefslogtreecommitdiff
path: root/tests/test_autodoc.py
Commit message (Collapse)AuthorAgeFilesLines
* test: Rename test_autodoc.py to test_ext_autodoc.pyTakeshi KOMIYA2020-05-061-1712/+0
|
* test: Merge test_ext_autodoc.py and test_autodoc.pyTakeshi KOMIYA2020-05-061-0/+21
|
* test: Do not use module level state-full fixtureTakeshi KOMIYA2020-05-061-82/+31
|
* Add test helper: make_directive_bridge()Takeshi KOMIYA2020-05-061-9/+15
|
* Merge branch '3.x' into 6857_enum_classmethodTakeshi KOMIYA2020-05-021-0/+9
|\
| * Fix #7559: autodoc: misdetects a sync function is asyncTakeshi KOMIYA2020-05-011-0/+9
| |
* | Fix #6857: autodoc: failed to detect a classmethod on Enum classTakeshi KOMIYA2020-04-301-7/+8
|/
* Close #7143: autodoc: Support final classes and methodsTakeshi KOMIYA2020-04-281-0/+33
|
* Merge pull request #7487 from thomascobb/singledispatch_autofunctionTakeshi KOMIYA2020-04-271-0/+32
|\ | | | | Support singledispatch autodoc directives
| * Support singledispatch in autofunction/methodThis makes autofunction and ↵Tom Cobb2020-04-241-0/+32
| | | | | | | | automethod work standalone withsingledispatch functions and methods. Previously only automodule wouldsupport these
* | Merge pull request #7564 from eric-wieser/fix-missing-__annotations__Takeshi KOMIYA2020-04-271-0/+7
|\ \ | | | | | | autodoc: Fix a logic error that causes annotations not to be shown for descriptors
| * | Fix a logic error that causes annotations not to be shown for descriptorsEric Wieser2020-04-271-0/+7
| |/ | | | | | | | | | | | | This `if not self._datadescriptor` was originally here before type annotations were supported, to prevent showing `descr4 = <_Descriptor ...>` in the docs. When type annotations were added, the support for appending `:type:` was put in the wrong place. It should have been outside this if, not within it.
* | autodoc: Suppress default value for uninitialized variablesTakeshi KOMIYA2020-04-201-1/+0
| |
* | Close #2044: autodoc: Suppress default value for instance attributesTakeshi KOMIYA2020-04-201-7/+0
|/
* test: Fix indentationTakeshi KOMIYA2020-04-051-1/+1
|
* Merge branch '2.x' into 3.0.xTakeshi KOMIYA2020-04-051-0/+13
|\
| * Fix: autodoc: `__wrapped__` functions are not documented correctlyTerence D. Honles2020-02-271-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Functions that are decorated with `@lru_cache` or other `functools` decorators may not even be detected as a function. This results in the documentation not having the `()` or even trying to render the function signature. This change updates the `sphinx.util.inspect` code to unwrap `__wrapped__` functions before determining if they can be documented. `@lru_cache` and its associated test is an example of a decorated function that is incorrectly identified as an attribute rather than a module level function and when rendering the signature (upon changing `isattributedescriptor`) the decorated function is still incorrectly identified as a C function. This change also renames the newly introduced `unwrap` as `unwrap_all` because it is different than the prexisting Python supplied `inspect.unwrap`. See `update_wrapper` "Changed in version 3.4" for more background: https://docs.python.org/3/library/functools.html#functools.update_wrapper
* | Fix #7355: autodoc: a signature of cython-function is not recognized wellTakeshi KOMIYA2020-03-311-1/+1
| |
* | Fix #7331: autodoc: a cython-method is not recognized as a methodTakeshi KOMIYA2020-03-221-0/+12
| |
* | Fix #7331: autodoc: a cython-function is not recognized as a functionTakeshi KOMIYA2020-03-221-0/+26
| |
* | Merge pull request #7358 from tk0miya/refactor_autodocTakeshi KOMIYA2020-03-221-160/+160
|\ \ | | | | | | refactor: autodoc: Remove needless spaces from blank line
| * | refactor: autodoc: Remove needless spaces from blank lineTakeshi KOMIYA2020-03-221-160/+160
| | |
* | | Update autodoc tests for new backslash handlingJakob Lykke Andersen2020-03-201-3/+3
|/ /
* | autodoc: Support singledispatch methodsTakeshi KOMIYA2020-03-071-0/+27
| |
* | Close #2815: autodoc: Support singledispatch functionsTakeshi KOMIYA2020-03-071-0/+19
| |
* | Close #7165: autodoc: Support Annotated type (PEP-593)Takeshi KOMIYA2020-03-031-0/+18
| |
* | Merge branch '2.4.x' into 3.xTakeshi KOMIYA2020-02-221-1/+17
|\ \ | |/
| * Fix #7189: autodoc: classmethod coroutines are not detectedTakeshi KOMIYA2020-02-221-1/+17
| |
* | Merge branch 'master' into 5637Takeshi KOMIYA2020-02-121-570/+377
|\ \
| * \ Merge branch '2.0'Takeshi KOMIYA2020-02-091-25/+53
| |\ \ | | |/
| | * autodoc: Support type_comment styled type annotation for variablesTakeshi KOMIYA2020-02-031-4/+26
| | |
| | * autodoc: Show type annotation for instance variablesTakeshi KOMIYA2020-02-031-0/+4
| | |
| | * autodoc: Support type annotations for variablesTakeshi KOMIYA2020-02-031-23/+25
| | |
| * | Merge branch '2.0'Takeshi KOMIYA2020-01-301-0/+66
| |\ \ | | |/
| | * Add testcase for instance variables without defaultsTakeshi KOMIYA2020-01-261-1/+15
| | |
| | * Close #7051: autodoc: Support instance variables without defaults (PEP-526)Takeshi KOMIYA2020-01-251-0/+41
| | |
| | * Merge branch '2.0' into 7023_partial_listed_as_module_membersTakeshi KOMIYA2020-01-191-3/+32
| | |\
| | * | Fix #7023: autodoc: partial functions are listed as module membersTakeshi KOMIYA2020-01-191-0/+11
| | | |
| * | | Merge branch '2.0'Takeshi KOMIYA2020-01-191-6/+41
| |\ \ \ | | | |/ | | |/|
| | * | Merge pull request #7031 from tk0miya/7023_nested_partial_functions_not_listedTakeshi KOMIYA2020-01-191-3/+9
| | |\ \ | | | |/ | | | | #7023: autodoc: nested partial functions are not listed
| | | * Fix #7023: autodoc: nested partial functions are not listedTakeshi KOMIYA2020-01-171-3/+9
| | | |
| | * | Add testcase a partialmethod not having docstring (refs: #7023)Takeshi KOMIYA2020-01-171-3/+32
| | |/
| * | Merge branch '2.0'Takeshi KOMIYA2020-01-111-7/+2
| |\ \ | | |/
| | * refactor: Add sphinx.util.inspect.signature()Takeshi KOMIYA2020-01-091-7/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | As a successor of sphinx.util.inspect.Singnature, this adds signature() function behaves like `inspect.signature()`. It is very similar to way of python's inspect module. In addition, this also adds stringify_annotation() helper to sphinx.util.inspect module. With these two functions, we can move to python's Signature object to represent function signatures perfectly. It's natural design for python developers than ever.
| * | Merge branch '2.0'Takeshi KOMIYA2020-01-011-1/+1
| |\ \ | | |/
| | * A happy new year!Takeshi KOMIYA2020-01-011-1/+1
| | |
| * | Close #5923: autodoc: allow not to document inherited members of specific ↵Takeshi KOMIYA2019-12-011-0/+24
| |/ | | | | | | super class
| * Merge branch '2.1.1' into 2.0Takeshi KOMIYA2019-06-101-24/+0
| |\
| | * Revert "Fix #1063: autodoc: automodule directive handles undocumented module ↵Takeshi KOMIYA2019-06-101-24/+0
| | | | | | | | | | | | | | | | | | | | | level variables" This reverts commit 69d93c967c591a65f10bcb9cb07e03d5cf03cce6 (without CHANGES).
| * | test: Update testcase for autoclass_content and autodoc_docstring_signatureTakeshi KOMIYA2019-06-031-33/+0
| | |
View Lorry Controller Status