summaryrefslogtreecommitdiff
path: root/tests/test_ext_autodoc.py
Commit message (Collapse)AuthorAgeFilesLines
* Fix #8099: autodoc: NameError is raised when script uses TYPE_CHECKINGTakeshi KOMIYA2020-08-131-0/+22
| | | | | | `typing.get_type_hints()` raises NameError when the target object contains unresolavable type annotation (ex. TYPE_CHECKING). This handles the exception and use unresolved annotations for type hints.
* Fix #8041: autodoc: An ivar on super class is not shown unexpectedlyTakeshi KOMIYA2020-08-081-6/+42
| | | | | | | | | An annotated instance variable on super class is not documented when derived class has also other annotated instance variables because `obj.__annotations__` is overrided by derived class's type hints. To get annotations of the target class correctly, this scans MRO to get all of annotated instance variables.
* refactor: test: Rename target.enum to target.enumsTakeshi KOMIYA2020-08-031-9/+9
| | | | | Using "enum" for module name bothers me on debugging errors because it sometimes raises ImportError.
* Fix #8032: autodoc: A typehint for inherited ivars is not shownTakeshi KOMIYA2020-08-021-0/+14
| | | | | This tries to import the parent object for the instance attribute to get type annotations for the variable.
* Fix #1362: autodoc: Support private class attributesTakeshi KOMIYA2020-07-181-0/+45
| | | | | | So far, autodoc treats a "private" class attribute as a mere attribute. But its name is mangled by python interpreter. This make it unmangled name to be documented expectedly.
* fixTakeshi KOMIYA2020-07-161-1/+14
|
* autodoc: the signature of base function will be shown for decorated functionsTakeshi KOMIYA2020-07-051-2/+2
|
* Fix #7812: autodoc: crashed when given name is conflictedTakeshi KOMIYA2020-07-041-10/+33
| | | | Note: this partially reverts #7594 to avoid errors.
* Fix #7844: autodoc: Failed to detect module when relative module name givenTakeshi KOMIYA2020-06-221-5/+43
|
* autodoc: Support TypeVar (refs: #7722)Takeshi KOMIYA2020-06-061-0/+40
|
* Support overloaded constructors (__call__, __init__ and __new__)Takeshi KOMIYA2020-06-021-0/+21
|
* Close #3610: autodoc: Support overloaded functionsTakeshi KOMIYA2020-05-311-0/+33
|
* Close #4422: autodoc: Support GenericAliasTakeshi KOMIYA2020-05-301-0/+31
|
* Fix autoclass signature parsingEric Wieser2020-05-281-32/+75
| | | | | | | | | | | | This fixes: * Signatures defined by __new__ * Signatures defined by metaclasses * Signatures defined by builtin base classes All of these changes bring the sphinx docs inline with the behavior of `inspect.signature`. Note that this changes autodoc to output `.. py:class: MyClass()` with parentheses even if no user-defined __init__ is present. This is quite deliberate, as if no user-defined `__init__` is present the default is `object.__init__`, which indeed does not take arguments.
* Fix #3673: autodoc: bysource order does not work for a module having __all__Takeshi KOMIYA2020-05-231-0/+34
|
* Merge pull request #7709 from tk0miya/refactor_test_ext_autodocTakeshi KOMIYA2020-05-231-136/+2
|\ | | | | refactor: test: Separate tests for autofunction
| * refactor: test: Separate tests for autofunctionTakeshi KOMIYA2020-05-221-136/+2
| |
* | Merge branch '3.x' into 7668_wront_retannTakeshi KOMIYA2020-05-221-11/+35
|\ \ | |/
| * Fix #7676: autodoc: typo in the default value of autodoc_member_orderTakeshi KOMIYA2020-05-171-1/+1
| |
| * refactor: autodoc: Remove magic mock from singledispatch processingTakeshi KOMIYA2020-05-161-8/+9
| |
| * Merge pull request #7663 from jakobandersen/astextJakob Lykke Andersen2020-05-161-1/+1
| |\ | | | | | | Fix astext() for two Sphinx nodes
| | * ... and don't break tests.Jakob Lykke Andersen2020-05-141-1/+1
| | |
| * | Fix #7650: autodoc: undecorated signature is shown for decorated functionsTakeshi KOMIYA2020-05-111-1/+24
| |/
* | Fix #7668: autodoc: wrong retann value is passed to autodoc-proccess-signatureTakeshi KOMIYA2020-05-161-1/+21
|/
* Fix test_ext_autodoc: Set testroot to testcasesTakeshi KOMIYA2020-05-111-0/+11
|
* Merge pull request #7623 from tk0miya/7362_autofunction_for_builtinsTakeshi KOMIYA2020-05-091-2/+41
|\ | | | | Fix #7362: autodoc: does not render correct signatures for built-in functions
| * Fix autodoc: does not render correct signatures for built-in methodsTakeshi KOMIYA2020-05-091-2/+15
| |
| * Fix #7362: autodoc: does not render correct signatures for built-in functionsTakeshi KOMIYA2020-05-091-0/+26
| |
* | Merge pull request #7624 from tk0miya/refactor_autodoc2Takeshi KOMIYA2020-05-091-0/+27
|\ \ | |/ |/| refactor: autodoc: class processors on autofunction is no longer needed
| * refactor: autodoc: class processors on autofunction is no longer neededTakeshi KOMIYA2020-05-071-0/+27
| |
* | Fix #7551: autodoc: failed to import nested classTakeshi KOMIYA2020-05-071-16/+16
|/
* test: Rename test_autodoc.py to test_ext_autodoc.pyTakeshi KOMIYA2020-05-061-0/+1712
|
* test: Merge test_ext_autodoc.py and test_autodoc.pyTakeshi KOMIYA2020-05-061-33/+0
|
* A happy new year!Takeshi KOMIYA2020-01-011-1/+1
|
* test: Use get_doctree() to load doctree filesTakeshi KOMIYA2019-02-171-3/+1
|
* 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.
* | The default setting for master_doc is changed to 'index'Takeshi KOMIYA2018-09-041-1/+1
|/
* Fix flake8 violationsTakeshi KOMIYA2018-02-191-0/+2
|
* autodoc: make full reference for classes, aliased with "alias of"Sergey B Kirpichev2018-01-131-0/+10
| | | | | | We do this here only if class belongs to the different module. Closes sphinx-doc/sphinx#2437
* A happy new year!Takeshi KOMIYA2018-01-011-1/+1
|
* Year++Takeshi KOMIYA2017-03-261-1/+1
|
* pytest: remove deprecated with_app decorator functionsshimizukawa2017-01-061-3/+2
|
* Fix `sphinx.ext.autodoc` crashes if target code imports * from mock modules ↵Takeshi KOMIYA2016-08-091-0/+25
by `autodoc_mock_imports`
View Lorry Controller Status