sphinx

canonical

Close #5603 : autodoc: Allow to refer to a python object using canonical name

2021-03-27 17:34:15 +09:00

name_conflict

Sort imports with isort

2020-11-11 13:19:05 +01:00

__init__.py

Sort imports with isort

2020-11-11 13:19:05 +01:00

abstractmethods.py

Close #744 : autodoc: Support abstractmethod

2019-05-15 00:01:00 +09:00

annotated.py

Close #7165 : autodoc: Support Annotated type (PEP-593)

2020-03-03 00:14:24 +09:00

annotations.py

Fix #8541 : autodoc_type_aliases doesn't work for the instance attrs

2020-12-17 01:07:54 +09:00

autoclass_content.py

Fix #6567 : autodoc: autodoc_inherit_docstrings does not effect to __init__()

2019-07-11 01:39:17 +09:00

bound_method.py

Address feedback

2019-04-13 22:09:01 -10:00

cached_property.py

Fix #8103 : autodoc: cached_property is not considered as a property

2020-08-13 23:16:59 +09:00

callable.py

Fix #6047 : autodoc: `autofunction` emits a warning for method objects

2019-02-17 18:23:14 +09:00

classes.py

refactor: Deprecate no_docstring argument for Documenter.add_content()

2020-12-26 21:14:26 +09:00

coroutine.py

Fix #7559 : autodoc: misdetects a sync function is async

2020-05-01 22:05:45 +09:00

cython.pyx

refactor: test: Pass language_level to cython explicitly

2020-05-04 00:23:06 +09:00

decorator.py

Fix #8105 : autodoc: the signature of decorated class is incorrect

2020-11-05 01:57:40 +09:00

descriptor.py

test: Move descriptor example to independent file

2019-06-03 00:38:01 +09:00

docstring_signature.py

Overloaded function signatures do not require a separating backslash

2021-03-27 10:25:20 -07:00

empty_all.py

Fix #8594 : autodoc: empty __all__ attribute is ignored

2020-12-28 13:53:56 +09:00

enums.py

refactor: test: Rename target.enum to target.enums

2020-08-03 02:30:30 +09:00

final.py

Close #7143 : autodoc: Support final classes and methods

2020-04-28 01:24:41 +09:00

functions.py

Add sphinx.util.inspect:iscoroutinefunction()

2019-04-23 01:40:37 +09:00

generic_class.py

Sort imports with isort

2020-11-11 13:19:05 +01:00

genericalias.py

Fix #8503 : autoattribute could not create document for a GenericAlias

2020-11-29 12:24:10 +09:00

hide_value.py

Close #8022 : autodoc: Allow to hide the value of the variables via metadata

2020-12-27 12:46:03 +09:00

imported_members.py

Fix #7023 : autodoc: partial functions are listed as module members

2020-01-19 15:22:09 +09:00

inheritance.py

Fix flake8 violations

2019-07-01 00:28:30 +09:00

instance_variable.py

Fix #741 : autodoc: inherited-members doesn't support instance attributes on super class

2020-12-18 23:24:59 +09:00

metadata.py

Fix #8597 : autodoc: metadata only docstring is treated as undocumented

2021-05-02 23:17:58 +09:00

methods.py

Add sphinx.util.inspect:iscoroutinefunction()

2019-04-23 01:40:37 +09:00

name_mangling.py

Fix #1362 : autodoc: Support private class attributes

2020-07-18 03:39:38 +09:00

need_mocks.py

Fix #8134 : autodoc: crashes when mocked decorator takes arguments

2021-01-24 14:18:00 +09:00

overload2.py

Fix #7786 : autodoc: can't detect overloaded methods defined in other file

2020-10-05 22:49:05 +09:00

overload.py

Close #8514 : autodoc: Default values of overloads are taken from actual implementation

2021-01-17 02:32:50 +09:00

partialfunction.py

Fix #7023 : autodoc: nested partial functions are not listed

2020-01-17 09:15:45 +09:00

partialmethod.py

Add testcase a partialmethod not having docstring (refs: #7023 )

2020-01-17 09:11:59 +09:00

pep570.py

Fix #7156 : autodoc: separator for keyword only arguments is not shown

2020-02-16 01:37:23 +09:00

pep604.py

autodoc: Support type union operator (PEP-604) (refs: #8775 )

2021-01-31 23:38:36 +09:00

preserve_defaults.py

Fix #759 : autodoc: Add sphinx.ext.autodoc.preserve_defaults extension

2021-03-06 18:48:18 +09:00

private.py

Fix #8592 : autodoc: :meta public: does not effect to variables

2020-12-27 22:21:34 +09:00

process_docstring.py

test: Update testcase for between()

2019-06-03 01:16:20 +09:00

properties.py

Fix #7383 : autodoc: Support typehints for properties

2021-03-13 22:51:46 +09:00

singledispatch.py

Fix #8872 : autodoc: stacked singledispatches are wrongly rendered

2021-05-03 21:51:19 +09:00

singledispatchmethod.py

Fix #8872 : autodoc: stacked singledispatches are wrongly rendered

2021-05-03 21:51:19 +09:00

slots.py

Fix #8545 : autodoc: a __slots__ attribute is not documented even having docstring

2020-12-17 22:19:28 +09:00

sort_by_all.py

Fix #3673 : autodoc: bysource order does not work for a module having __all__

2020-05-23 21:52:11 +09:00

TYPE_CHECKING.py

Fix #8099 : autodoc: NameError is raised when script uses TYPE_CHECKING

2020-08-13 22:57:12 +09:00

typed_vars.py

Fix #8534 : autoattribute failed to document a commented attribute in alias dervied class

2020-12-17 22:13:20 +09:00

typehints.py

Test autodoc_typehint_undoc

2021-03-27 14:54:38 -04:00

typevar.py

Close #8924 : autodoc: Support bound argument for TypeVar

2021-02-24 22:51:06 +09:00

uninitialized_attributes.py

Fix #8800 : autodoc: Uninitialized attributes in superclass are recognized as undocumented

2021-02-01 21:06:07 +09:00

wrappedfunction.py

Fix #7807 : autodoc: wrong signature is shown for the function using contextmanager

2020-06-14 01:31:18 +09:00