summaryrefslogtreecommitdiff
path: root/sphinx/ext/autodoc/directive.py
Commit message (Collapse)AuthorAgeFilesLines
* Resolve ``flake8-return`` errorsAdam Turner2023-02-181-16/+15
|
* Fix COM812Adam Turner2023-02-181-2/+2
|
* Use PEP 604 typesAdam Turner2023-01-011-2/+2
|
* Use PEP 595 typesAdam Turner2023-01-011-5/+5
|
* Insert ``from __future__ import annotations``Adam Turner2023-01-011-0/+2
|
* Merge branch '5.x'Adam Turner2022-09-091-2/+2
|\ | | | | | | | | | | | | | | | | # Conflicts: # setup.py # sphinx/application.py # sphinx/environment/__init__.py # sphinx/ext/autodoc/directive.py # tests/test_build_html.py
| * Fix more strict static typing errors (#10681)danieleades2022-08-281-2/+2
| |
* | Remove deprecated items for Sphinx 6.0 (#10471)Adam Turner2022-06-161-14/+0
|/
* Remove deprecated code for Sphinx 5.0Adam Turner2022-04-171-7/+1
|
* Remove copyright and licence fieldsAdam Turner2022-02-201-5/+0
|
* Fix module docstring indentationAdam Turner2022-02-201-2/+2
|
* Remove module titles in docstringsAdam Turner2022-02-191-3/+0
|
* Close #10146: autodoc: autodoc_default_options does not support `no-value` ↵Takeshi KOMIYA2022-01-311-1/+1
| | | | option
* A happy new year!Takeshi KOMIYA2022-01-011-1/+1
|
* Fix warning typo; improve sphinx.ext.autodoc docstringsLouis Maddox2021-07-191-4/+4
|
* Close #8107: autodoc: Add class-doc-from option to autoclass directiveTakeshi KOMIYA2021-05-011-1/+1
| | | | | | Add `class-doc-from` option to the `autoclass` directive to control the content of the specific class. It takes `class`, `init`, and `both` like `autoclass_content`.
* refactor: use raw Type for type annotationsTakeshi KOMIYA2021-04-041-1/+1
|
* Deprecate DocumenterBridge.warn()Takeshi KOMIYA2021-03-221-0/+3
| | | | | | | | Since 1.6, sphinx.util.logging module became the default logging interface of Sphinx. It allows sphinx-components to output log without the app (or env) object. According to the policy, DocumenterBridge.warn() is no longer needed and should be replaced by the logging module.
* Rename DocumenterBridge.filename_set to record_dependenciesTakeshi KOMIYA2021-03-211-3/+9
| | | | | | | DocumenterBridge.filename_set has been used since its beginning. On the other hand, in docutils, record_dependencies attribute is well-used to store the list of dependency files. So this renames it to docutils' standard attribute.
* refactor: Use PEP-526 based variable annotation (sphinx.ext)Takeshi KOMIYA2021-03-151-2/+2
|
* Merge branch '3.x' into merge_3.x_into_masterjfbu2021-02-041-1/+16
|\ | | | | | | | | Resolved Conflicts: sphinx/texinputs/sphinxpackagefootnote.sty
| * Merge remote-tracking branch 'upstream/3.x' into exclude-members-fixpbudzyns2021-02-011-3/+9
| |\
| * | check if autodoc_defaults are str, fix testspbudzyns2021-02-011-3/+3
| | |
| * | code formatpbudzyns2021-01-291-1/+2
| | |
| * | add private-members as extendablepbudzyns2021-01-291-1/+1
| | |
| * | local options handlingpbudzyns2021-01-291-2/+1
| | |
| * | redundant '+' has no effectpbudzyns2021-01-251-0/+5
| | |
| * | add more extendable options and testspbudzyns2021-01-251-1/+2
| | |
| * | add more extendable options and testspbudzyns2021-01-251-4/+8
| | |
| * | local exclude-members option fixroot2020-10-061-1/+6
| | |
* | | Merge branch '3.x'Takeshi KOMIYA2021-01-161-1/+9
|\ \ \ | | |/ | |/|
| * | refactor: Deprecate DocumenterBrdige.reporterTakeshi KOMIYA2021-01-121-2/+8
| | | | | | | | | | | | | | | The logging system of Sphinx was migrated to sphinx.util.logging now. So it's time to deprecate reporter interface for Documenters.
* | | Merge branch '3.x'Takeshi KOMIYA2021-01-011-1/+1
|\ \ \ | |/ /
| * | 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
| * Add stacklevel parameter to warnings.warn() callTakeshi KOMIYA2020-05-031-1/+1
| |
* | Do isortTakeshi KOMIYA2020-11-121-1/+0
| |
* | Remove deprecated features marked as RemovedInSphinx40WarningTakeshi KOMIYA2020-04-291-14/+3
| |
* | Merge branch '3.x'Takeshi KOMIYA2020-03-211-2/+2
|\ \ | |/
| * Deprecate sphinx.ext.autodoc.get_documenters()Takeshi KOMIYA2020-03-161-2/+2
| |
* | Merge branch '3.x'Takeshi KOMIYA2020-03-101-1/+1
|\ \ | |/
| * Fix #7267: autodoc: errormsg for invalid directive options has wrong locationTakeshi KOMIYA2020-03-071-1/+1
| |
* | Deprecate codes for python 3.5Takeshi KOMIYA2020-03-071-5/+1
|/
* Fix type annotation for python 3.5.1Takeshi KOMIYA2019-07-131-2/+7
|
* Migrate to py3 style type annotation: sphinx.ext.autodoc.directiveTakeshi KOMIYA2019-07-011-27/+18
|
* Fix #6165: autodoc: ``tab_width`` setting of docutils has been ignoredTakeshi KOMIYA2019-04-251-4/+18
|
* Add imported-members to the directive whitelistAlex Sergeev2019-04-131-1/+2
|
* Clean up import for annotationsTakeshi KOMIYA2019-03-061-2/+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.
* Replace all "unicode" type by "str"Takeshi KOMIYA2018-12-151-3/+2
|
* Add docutils-stubs to test depsTakeshi KOMIYA2018-12-151-1/+1
|
View Lorry Controller Status