summaryrefslogtreecommitdiff
path: root/sphinx/ext/autodoc
Commit message (Collapse)AuthorAgeFilesLines
...
* Merge pull request #10285 from jmp1985/masterTakeshi KOMIYA2022-04-051-4/+4
|\ | | | | Fixed singledispatch documentation
| * Removed white spaceJames Parkhurst2022-03-211-1/+1
| |
| * Fixed singledispatch documentationJames Parkhurst2022-03-211-4/+4
| |
* | Merge branch '5.x' into autodoc_force_undocumented_rtypeTakeshi KOMIYA2022-04-031-4/+8
|\ \
| * | Close #8417: autodoc: :inherited-members: option now takes multiple classesTakeshi KOMIYA2022-04-031-4/+8
| | | | | | | | | | | | | | | It allows to suppress inherited members of several classes on the module at once by specifying the option to `automodule` directive
* | | autodoc_typehints_description_target: Rename ↵Takeshi KOMIYA2022-04-032-3/+2
| | | | | | | | | | | | returnvalue_and_documented_params to documented_params
* | | Merge branch '5.x' into autodoc_force_undocumented_rtypeTakeshi KOMIYA2022-04-038-173/+193
|\ \ \ | |/ /
| * | Merge pull request #10321 from ↵Takeshi KOMIYA2022-04-031-1/+5
| |\ \ | | | | | | | | | | | | | | | | tk0miya/10266_autodoc_preserve_defaults_crashes_on_kwonlyargs_without_defaults Fix #10266: autodoc_preserve_defaults crashes on kwonlyargs w/o defaults
| | * \ Merge branch '5.x' into ↵Takeshi KOMIYA2022-04-031-0/+14
| | |\ \ | | | | | | | | | | | | | | | 10266_autodoc_preserve_defaults_crashes_on_kwonlyargs_without_defaults
| | * | | Fix #10266: autodoc_preserve_defaults crashes on kwonlyargs w/o defaultsTakeshi KOMIYA2022-04-021-1/+5
| | | | |
| * | | | Merge pull request #10313 from ↵Takeshi KOMIYA2022-04-031-3/+9
| |\ \ \ \ | | |_|/ / | |/| | | | | | | | | | | | | GutiCW/feature-support_mocked_decorator_for_class_methods Support mocked decorator for class methods
| | * | | Reduce complexity by removing recursion.Christian Walch2022-04-011-2/+4
| | | | |
| | * | | Move method `isboundmethod()` into sphinx/util/inspect.py.Christian Walch2022-04-011-9/+1
| | | | |
| | * | | Rename function `_method_is_bound()` -> `isboundmethod()`.Christian Walch2022-04-011-2/+2
| | | | |
| | * | | Add types and docstring to function `_method_is_bound()`.Christian Walch2022-03-311-1/+2
| | | | |
| | * | | Add unwittingly removed empty line.Christian Walch2022-03-311-0/+1
| | | | |
| | * | | Use recursive call to `ismock()` on unbound method instead of using ↵Christian Walch2022-03-311-4/+2
| | | | | | | | | | | | | | | | | | | | temporary object.
| | * | | Closes #10310: Sphinx automodule: class method not documented when decorated ↵Christian Walch2022-03-311-3/+15
| | | | | | | | | | | | | | | | | | | | with mocked function.
| * | | | Fix #10280: autodoc_docstring_signature generates needless return typehintTakeshi KOMIYA2022-04-031-0/+14
| | |/ / | |/| | | | | | | | | | | | | | | | | | | | | | Basically, autodoc suppresses return value typehint for class constructors. But it was unexpectedly shown if `autodoc_docstring_signature` is enabled and docstring has multiple signatures.
| * | | Merge branch '4.x'Takeshi KOMIYA2022-03-271-1/+1
| |\ \ \ | | |/ / | | | / | | |/ | |/|
| | * Update PEP links in docsHugo van Kemenade2022-03-241-1/+1
| | |
| * | Merge branch '4.x'Takeshi KOMIYA2022-03-198-70/+12
| |\ \ | | |/
| | * Collapse single line docstringsAdam Turner2022-02-205-10/+5
| | |
| | * Remove copyright and licence fieldsAdam Turner2022-02-208-26/+0
| | |
| | * Conform to PEP 257 summary line conventionsAdam Turner2022-02-202-2/+6
| | |
| | * Fix module docstring indentationAdam Turner2022-02-208-19/+19
| | |
| | * Fix module docstring first lineAdam Turner2022-02-207-14/+7
| | |
| | * Remove module titles in docstringsAdam Turner2022-02-198-24/+0
| | |
| * | Merge branch '4.x'Takeshi KOMIYA2022-02-192-5/+9
| |\ \ | | |/
| | * Merge pull request #10150 from ↵Takeshi KOMIYA2022-02-062-2/+3
| | |\ | | | | | | | | | | | | | | | | tk0miya/10146_autodoc_default_options_should_support_no-value Close #10146: autodoc: autodoc_default_options does not support `no-value` option
| | | * Close #10146: autodoc: autodoc_default_options does not support `no-value` ↵Takeshi KOMIYA2022-01-312-2/+3
| | | | | | | | | | | | | | | | option
| | * | Merge branch '4.4.x' into 4.xTakeshi KOMIYA2022-02-061-3/+6
| | |\ \ | | | |/ | | |/|
| | | * Fix #9876: autodoc: ocument a class on binary moduleTakeshi KOMIYA2022-01-301-3/+6
| | | |
| * | | Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9'Takeshi KOMIYA2022-02-141-0/+5
| |\ \ \ | | |/ /
| | * | Fix #10133: autodoc: Crashed when mocked module is used for type annotationTakeshi KOMIYA2022-01-301-0/+5
| | |/
| * | autodoc: The default of autodoc_typehints_format becomes to 'smart'Takeshi KOMIYA2022-01-021-1/+1
| |/ | | | | | | | | | | | | | | The default value of autodoc_typehints_format configuration is changed to `'smart'`. It will suppress the leading module names of typehints (ex. `io.StringIO` -> `StringIO`). refs: #9075
| * Merge pull request #10034 from tk0miya/10027_autodoc_typehints_format_for_basesTakeshi KOMIYA2022-01-021-5/+26
| |\ | | | | | | Fix #10027: autodoc_typehints_format does not work with :show-inheritance:
| | * Fix #10027: autodoc_typehints_format does not work with :show-inheritance:Takeshi KOMIYA2022-01-011-5/+26
| | |
| * | Merge branch '4.3.x' into 4.xTakeshi KOMIYA2022-01-018-8/+8
| |\ \
| | * | A happy new year!Takeshi KOMIYA2022-01-018-8/+8
| | | |
| * | | Merge pull request #10021 from ↵Takeshi KOMIYA2021-12-291-2/+7
| |\ \ \ | | | | | | | | | | | | | | | | | | | | tk0miya/10015_typehints_format_with_typehints_in_description Fix #10015: autodoc: autodoc_typehints_format='short' does not work when autodoc_typehints='description'
| | * | | Fix #10015: autodoc: autodoc_typehints_format='short' does not work when ↵Takeshi KOMIYA2021-12-271-2/+7
| | | |/ | | |/| | | | | | | | | autodoc_typehints='description'
| * | | Merge branch '4.x' into 10009_exception_on_getdocTakeshi KOMIYA2021-12-271-7/+8
| |\ \ \ | | |/ /
| | * | autodoc: Rename autodoc_unqualified_typehints to autodoc_typehints_format ↵Takeshi KOMIYA2021-12-241-7/+8
| | |/ | | | | | | | | | (refs: #9931)
| * | Fix autodoc: Update error message on filtering membersTakeshi KOMIYA2021-12-271-2/+2
| | |
| * | Fix #10009: autodoc: Crashes if subject raises an error on getdoc()Takeshi KOMIYA2021-12-241-86/+88
| |/
| * Close #9075: autodoc: Add a config variable autodoc_unqualified_typehintsTakeshi KOMIYA2021-12-031-0/+16
| | | | | | | | | | | | If autodoc_unqualified_typehints feature enabled, autodoc suppresses the leading module names of typehints of function signatures (ex. `io.StringIO` -> `StringIO`)
* | feat: add tests and fix None rtypegschwaer2021-11-291-4/+6
| |
* | feat: add new option for autodoc_typehints_description_target to include ↵gschwaer2021-11-292-3/+11
|/ | | | undocumented return values
* Fix #9883: autodoc: doccomment for the alias to mocked object was ignoredTakeshi KOMIYA2021-11-292-8/+11
|
View Lorry Controller Status