summaryrefslogtreecommitdiff
path: root/sphinx/ext/autosummary
Commit message (Collapse)AuthorAgeFilesLines
* Autosummary: Always emit grouped ``ImportError`` exceptions (#11380)Adam Turner2023-04-281-15/+5
|
* autosummary: Support documenting inherited attributes (#10691)Jens Hedegaard Nielsen2023-04-061-7/+17
| | | | | | | | | | | The current implementation of ``import_ivar_by_name`` filters attributes if the name of the object that the attribute belongs to does not match the object being documented. However, for inherited attributes this is not the case. Filtering only on the attribute name seems to resolve the issue. It is not clear to me if there are any unwanted sideeffects of this and we should filter on the list of qualnames for the object and all its super classes (if any). Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* 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-182-3/+2
|
* Fix COM812Adam Turner2023-02-182-4/+4
|
* 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-072-8/+24
| | | | 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-022-8/+8
|
* Use PEP 604 typesAdam Turner2023-01-012-16/+16
|
* Use PEP 595 typesAdam Turner2023-01-012-55/+55
|
* Insert ``from __future__ import annotations``Adam Turner2023-01-012-0/+4
|
* Factor out HTML 4 translator (#11051)Adam Turner2022-12-301-2/+2
| | | Move the HTML 4 translator into a private module.
* Merge branch '5.x'Adam Turner2022-09-251-0/+3
|\ | | | | | | | | | | | | | | | | | | # Conflicts: # CHANGES # doc/conf.py # sphinx/__init__.py # sphinx/builders/html/__init__.py # sphinx/domains/python.py # tests/test_build_html.py
| * Define extra indent as a class attributeAdam Turner2022-09-251-0/+3
| |
* | Merge branch '5.x'Adam Turner2022-09-092-16/+23
|\ \ | |/ | | | | | | | | | | | | | | # 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-282-16/+23
| |
* | Merge branch '5.x'Adam Turner2022-07-241-1/+1
|\ \ | |/ | | | | | | | | # Conflicts: # CHANGES # sphinx/__init__.py
| * Update include_patterns implementation (#10680)Adam Turner2022-07-231-1/+1
| |
* | Merge branch '5.x'Adam Turner2022-07-181-3/+4
|\ \ | |/ | | | | | | | | # Conflicts: # sphinx/ext/autodoc/__init__.py # sphinx/writers/html5.py
| * Improve static typing strictness (#10569)danieleades2022-07-181-3/+4
| |
* | Merge branch '5.x'Adam Turner2022-07-171-1/+1
|\ \ | |/
| * Add `include_patterns` as the opposite of `exclude_patterns` (#10518)Adam Turner2022-07-171-1/+1
| |
* | Remove deprecated items for Sphinx 6.0 (#10471)Adam Turner2022-06-161-10/+1
|/
* remove unnecessary generators (C400, C401)Daniel Eades2022-06-032-3/+3
|
* 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-072-137/+50
|\
| * Remove deprecated code for Sphinx 5.0Adam Turner2022-04-172-86/+10
| |
| * Merge branch '4.x'Takeshi KOMIYA2022-03-192-51/+40
| |\
| | * Merge pull request #10212 from AA-Turner/remove-module-docstring-titlesTakeshi KOMIYA2022-03-142-50/+39
| | |\ | | | | | | | | Remove module docstring titles
| | | * Remove copyright and licence fieldsAdam Turner2022-02-202-6/+0
| | | |
| | | * Conform to PEP 257 summary line conventionsAdam Turner2022-02-202-4/+7
| | | |
| | | * Fix module docstring indentationAdam Turner2022-02-202-40/+40
| | | |
| | | * Fix module docstring first lineAdam Turner2022-02-202-4/+2
| | | |
| | | * Remove module titles in docstringsAdam Turner2022-02-192-6/+0
| | | |
| | * | Close #10234: autosummary: Add "autosummary" CSS class to summary tablesTakeshi KOMIYA2022-03-061-1/+1
| | |/
* | | 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-172-4/+4
|\ \ | |/
| * address some unused loop control variables (B007)Daniel Eades2022-01-122-4/+4
| |
* | Merge branch '4.x'Takeshi KOMIYA2022-01-161-2/+0
|\ \ | |/
| * Fix #10058: autosummary: Imported members are not shownTakeshi KOMIYA2022-01-111-2/+0
| | | | | | | | | | | | | | | | | | | | | | | | Originally, the `check_module()` call was added at 21b8384 to hide imported members on generating stubs. But it was incorrect approach. Therefore it was disabled by b433197 and fixed the original issue by another approach at 2390c554. Finally, the `check_module()` call becomes meaningless code. But, at present, it causes that imported members are not shown when `autodoc_class_signature` is 'separated'. To resolve the problem, this removes the meaningless call.
* | Merge branch '4.x'Takeshi KOMIYA2022-01-031-1/+1
|\ \ | |/
| * Migrate to Node.findall() from Node.traverse()Takeshi KOMIYA2022-01-031-1/+1
| | | | | | | | | | | | | | | | Node.traverse() was marked as deprecated since docutils-0.18. Instead of it, Node.findall() has been added as successor of traverse(). This applies a patch to docutils-0.17 or older to be available Node.findall() and use it.
* | autosummary: autosummary: import_by_name() now raises ImportExceptionGroupTakeshi KOMIYA2022-01-022-8/+14
|/ | | | | It starts to `ImportExceptionGroup` exception instead of `ImportError` by default when it failed to import target object.
View Lorry Controller Status