summaryrefslogtreecommitdiff
path: root/sphinx/ext/autosummary/generate.py
Commit message (Collapse)AuthorAgeFilesLines
* Autosummary: Extend ``__all__`` members to template rendering (#10811)Clément Pinard2023-04-061-3/+49
| | | | | | | | | | | | | When ``False``, the ``autosummary_ignore_module_all`` option adds members to the module's members entry that will be used for autodoc, but otherwise ignores it. As such, if a class is available in the ``__all__``, it won't be generated. This commit aims to extend the ``__all__`` handling not only to members, but also to corresponding attribute types (function, classes, exceptions, modules) The ``imported_members`` option is set to ``True`` if the object has an ``__all__`` member and ``autosummary_ignore_module_all`` is ``False``
* Remove ``sphinx.locale.setlocale``Adam Turner2023-03-241-4/+3
|
* Resolve ``flake8-return`` errorsAdam Turner2023-02-181-1/+1
|
* Fix COM812Adam Turner2023-02-181-2/+2
|
* Resolve Ruff SIM114 violationsAdam Turner2023-02-151-6/+6
|
* Fix various Ruff errorsAdam Turner2023-01-311-2/+4
|
* Adopt ``profile = "black"`` for ``isort``Adam Turner2023-01-071-6/+17
| | | | This allows using Ruff's import sorting fixers
* Document ``typing.NewType`` as a class (#10700)Adam Turner2023-01-021-3/+2
|
* Run pyupgrade (#11070)Adam Turner2023-01-021-4/+4
|
* Use PEP 604 typesAdam Turner2023-01-011-8/+8
|
* Use PEP 595 typesAdam Turner2023-01-011-27/+27
|
* Insert ``from __future__ import annotations``Adam Turner2023-01-011-0/+2
|
* Fix more strict static typing errors (#10681)danieleades2022-08-281-8/+12
|
* remove unnecessary generators (C400, C401)Daniel Eades2022-06-031-2/+2
|
* remove unnecessary list calls around 'sorted' (C413)Daniel Eades2022-06-031-1/+1
|
* Fix #10509: autosummary: autosummary fails with a shared libraryTakeshi KOMIYA2022-06-031-2/+6
|
* autosummary: global variables having doc-comment are considered as ↵Takeshi KOMIYA2022-05-071-2/+4
| | | | non-imported members of the module
* Fix a flake8 warningTakeshi KOMIYA2022-05-071-1/+0
|
* Merge branch '5.x' into 10258_autosummaryTakeshi KOMIYA2022-05-071-69/+15
|\
| * Remove deprecated code for Sphinx 5.0Adam Turner2022-04-171-56/+7
| |
| * Merge branch '4.x'Takeshi KOMIYA2022-03-191-13/+8
| |\
| | * Remove copyright and licence fieldsAdam Turner2022-02-201-3/+0
| | |
| | * Conform to PEP 257 summary line conventionsAdam Turner2022-02-201-1/+3
| | |
| | * Fix module docstring indentationAdam Turner2022-02-201-8/+8
| | |
| | * Fix module docstring first lineAdam Turner2022-02-201-2/+1
| | |
| | * Remove module titles in docstringsAdam Turner2022-02-191-3/+0
| | |
* | | Do not pass attr_docs as an argument into ModuleScanner.scanMatyas Novak2022-03-141-4/+6
| | |
* | | Recognize a documented attribute of a module as non-imported.Matyas Novak2022-03-111-5/+6
|/ /
* | Merge branch '4.x'Takeshi KOMIYA2022-01-171-1/+1
|\ \ | |/
| * address some unused loop control variables (B007)Daniel Eades2022-01-121-1/+1
| |
* | autosummary: autosummary: import_by_name() now raises ImportExceptionGroupTakeshi KOMIYA2022-01-021-2/+2
|/ | | | | It starts to `ImportExceptionGroup` exception instead of `ImportError` by default when it failed to import target object.
* Merge branch '4.3.x' into 4.xTakeshi KOMIYA2022-01-011-1/+1
|\
| * A happy new year!Takeshi KOMIYA2022-01-011-1/+1
| |
* | Close #9555: autosummary: Improve error messages on failure to load target ↵Takeshi KOMIYA2021-12-301-9/+18
|/ | | | object
* Fix lints and reorder args of members_ofJosh Mitchell2021-11-221-6/+7
|
* Fixed missed ignore___all__ -> ignore_module_allJosh Mitchell2021-11-151-7/+7
|
* Corrections from review by tk0miyaJosh Mitchell2021-11-151-1/+1
|
* #2021: Allow autosummary to respect __all__Josh Mitchell2021-11-151-5/+25
|
* Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|gJon Dufresne2021-09-061-1/+1
| | | | | | https://sphinx-doc.org is unreachable, but is linked from the PyPI page: https://pypi.org/project/Sphinx/. Switch to https://www.sphinx-doc.org/ instead.
* revert get members for modulepbudzyns2021-05-021-8/+20
|
* add type hintsPawel Budzynski2021-04-291-2/+2
|
* autosummary includes instance attributesPawel Budzynski2021-04-291-5/+11
|
* Merge pull request #9064 from tk0miya/refactor_type_annotationTakeshi KOMIYA2021-04-081-1/+1
|\ | | | | refactor: Add Optional to type annotations
| * refactor: Add Optional to type annotationsTakeshi KOMIYA2021-04-081-1/+1
| |
* | refactor: Use PEP-526 based variable annotationTakeshi KOMIYA2021-04-081-9/+9
|/
* refactor: Use PEP-526 based variable annotation (sphinx.ext)Takeshi KOMIYA2021-03-151-1/+1
|
* Merge branch '3.x'Takeshi KOMIYA2021-01-221-0/+4
|\
| * refactor: autosummary: Deprecate _simple_info() and _simple_warn()Takeshi KOMIYA2021-01-201-0/+4
| |
* | Merge branch '3.x'Takeshi KOMIYA2021-01-011-1/+1
|\ \ | |/
| * Merge branch '3.4.x' into 3.xTakeshi KOMIYA2021-01-011-1/+1
| |\