summaryrefslogtreecommitdiff
path: root/sphinx/ext
Commit message (Collapse)AuthorAgeFilesLines
* Remove 'sphinx.ext.duration' from the mypy whitelist (#11404)danieleades2023-05-121-1/+1
|
* html builder: Append CRC32 checksum to asset URIs (#11415)Adam Turner2023-05-111-8/+8
|
* Autosummary: Always emit grouped ``ImportError`` exceptions (#11380)Adam Turner2023-04-281-15/+5
|
* Remove the deprecated ``sphinx.ext.napoleon.iterators`` module (#11364)Adam Turner2023-04-271-235/+0
|
* Harmonise references to Sphinx versions (#11361)Adam Turner2023-04-271-2/+2
|
* Revert "Support and prefer ``.jinja`` to ``_t`` for static templates ↵James Addison2023-04-232-16/+10
| | | | | (#11165)" (#11329) This reverts commit 5d13215b58f93c6be8255ef2e3e20836508c7d47.
* Support and prefer ``.jinja`` to ``_t`` for static templates (#11165)James Addison2023-04-072-10/+16
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* 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>
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-061-4/+4
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* Support type comments in ``PropertyDocumenter`` (#11298)picnixz2023-04-061-23/+36
|
* Clean up the CNAME file in ``sphinx.ext.githubpages`` (#11295)Martin Liška2023-04-061-13/+38
| | | 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``
* support for imgmath_latex=tectonic (#11281)Dimitar Dimitrov2023-04-031-4/+15
| | | | | | | | | | | * add rudimentary support for using tectonic with imgmath * fix typo * addressing PR comment * revert changes to preview.tex_t; add dvips by default for SVG * bugfix
* Fix typos found by codespellDimitri Papadopoulos2023-03-272-2/+2
|
* Remove ``sphinx.locale.setlocale``Adam Turner2023-03-242-6/+5
|
* Miscellaneous ``intersphinx`` refactorsAdam Turner2023-03-171-9/+15
| | | | | | - Refactor usage of ``inventories.cache`` in ``load_mappings()`` - Iterate once over ``cached_vals`` - Avoid a line continuation character in ``_resolve_reference()``
* Improve static typing in ``intersphinx`` et alAdam Turner2023-03-171-19/+43
|
* Deprecate legacy ``intersphinx_mapping`` format (#11247)Adam Turner2023-03-171-0/+8
| | | This format was made obsolete in Sphinx 1.0, but never formally deprecated.
* Drop OrderedDictAdam Turner2023-03-051-2/+1
| | | | Since Python 3.7, dicts maintain insertion order.
* Resolve ``flake8-return`` errorsAdam Turner2023-02-185-39/+33
|
* Unescape quotation marks where possibleAdam Turner2023-02-182-2/+2
|
* Fix pytest style issuesAdam Turner2023-02-181-1/+2
|
* Fix COM812Adam Turner2023-02-1818-73/+74
|
* Add ``content_offset`` parameter to ``nested_parse_with_titles`` (#11147)Jeremy Maitin-Shepard2023-02-152-3/+2
| | | | | | | | | | | | | | | | | | | | | | | Previously, ``nested_parse_with_titles`` always passed ``0`` as the input offset when invoking ``nested_parse``. When parsing the content of a directive, as is a common use case for ``nested_parse_with_titles``, this leads to incorrect source file/line number information, as it does not take into account the directive's ``content_offset``, which is always non-zero. This issue affects *all* object descriptions due to GH-10887. It also affects the ``sphinx.ext.ifconfig`` extension. The ``py:module`` and ``js:module`` directives employed a workaround for this issue, by wrapping the calls to ``nested_parse_with_title`` with ``switch_source_input``. That worked, but was more complicated (and likely less efficient) than necessary. This commit adds an optional ``content_offset`` parameter to ``nested_parse_with_titles``, and fixes callers to pass the appropriate content offset when needed. This commit eliminates the now-unnecessary calls to ``switch_source_input`` and instead specifies the correct ``content_offset``.
* Resolve Ruff SIM114 violationsAdam Turner2023-02-156-37/+26
|
* Collapse ``.startswith`` and ``.endswith`` testsAdam Turner2023-02-091-2/+2
|
* Fix various Ruff errorsAdam Turner2023-01-313-5/+10
|
* Adopt ``profile = "black"`` for ``isort``Adam Turner2023-01-075-16/+57
| | | | This allows using Ruff's import sorting fixers
* Merge branch '6.0.x'Adam Turner2023-01-051-4/+5
|\ | | | | | | | | # Conflicts: # CHANGES
| * imgmath: Fix relative file path (#10965)Julien Schueller2023-01-051-4/+5
| |
* | Move console output utilities to ``sphinx.util.display``Adam Turner2023-01-031-1/+2
| | | | | | | | | | - Merge `old_status_iterator` into ``status_iterator``. ``old_status_iterator`` was deprecated in version 1.6.
* | Document ``typing.NewType`` as a class (#10700)Adam Turner2023-01-022-116/+80
| |
* | Use PEP 604 display for ``typing.Optional`` and ``typing.Union`` (#11072)Adam Turner2023-01-023-18/+22
| |
* | Address SIM103 lints (#11052)danieleades2023-01-023-17/+4
| | | | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* | Use ``any`` to find elements in iterable (#11053)danieleades2023-01-023-18/+17
| |
* | Run pyupgrade (#11070)Adam Turner2023-01-0213-57/+56
| |
* | Use PEP 604 typesAdam Turner2023-01-0117-136/+136
| |
* | Use PEP 595 typesAdam Turner2023-01-0128-342/+341
| |
* | Insert ``from __future__ import annotations``Adam Turner2023-01-0129-0/+58
| |
* | Factor out HTML 4 translator (#11051)Adam Turner2022-12-306-18/+18
| | | | | | Move the HTML 4 translator into a private module.
* | Enable Ruff's flake8-bandit checksAdam Turner2022-12-291-2/+2
| |
* | Enable Ruff's pylint checksAdam Turner2022-12-291-2/+1
| | | | | | | | | | Also fix two PLW0602 warnings (``global`` without assignment) and five PLW0120 warnings (else clause on loop without break).
* | Enable Ruff's pygrep-hooks checksAdam Turner2022-12-292-2/+2
| |
* | Tighten mypy 'strict optional' whitelist (#11038)danieleades2022-12-295-34/+73
|/ | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Remove unnecessary conditional import in ``sphinx.ext.napoleon`` (#11043)Antony Lee2022-12-291-16/+11
| | | | | The conditional import could have been useful for the external sphinxcontrib.napoleon (to keep backcompat with older versions of sphinx), but seems just confusing for a builtin extension.
* remove blanket 'noqas'Daniel Eades2022-12-161-1/+4
|
* Deactivate (provisorily) Python12-dev testing (#11035)Jean-François B2022-12-162-4/+4
| | | | | | | | | | | | | * fix flake8 warnings * Deactivate (provisorily) testing with 3.12-dev (refs: https://github.com/sphinx-doc/sphinx/pull/10995#issuecomment-1330310586 ) * Escape # in tox.ini for tox 4 compatibility ('du-latest' tests) Co-authored-by: Daniel Eades <danieleades@hotmail.com>
* Update typing ignores for mypy 0.990Adam Turner2022-11-134-7/+7
|
* Run the ``pyupgrade`` toolAdam Turner2022-10-175-12/+12
|
* Use ``ast.parse`` from the standard libraryAdam Turner2022-10-172-8/+6
|
View Lorry Controller Status