IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Make some typographical edits to CHANGES

Browse Source
This commit is contained in:
Adam Turner 2024-07-15 05:53:41 +01:00
parent f10f0b6fb5
commit 4e8500c002
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CHANGES.rst
View File

@ -88,21 +88,21 @@ Features added
* #11592: Add :confval:`coverage_modules` to the coverage builder * #11592: Add :confval:`coverage_modules` to the coverage builder
to allow explicitly specifying which modules should be documented. to allow explicitly specifying which modules should be documented.
Patch by Stephen Finucane. Patch by Stephen Finucane.
* #7896, #11989: Add a :rst:dir:`py:type` directiv for documenting type aliases, * #7896, #11989: Add a :rst:dir:`py:type` directive for documenting type aliases,
and a :rst:role:`py:type` role for linking to them. and a :rst:role:`py:type` role for linking to them.
Patch by Ashley Whetter. Patch by Ashley Whetter.
* #12549 Add optional ``description`` argument to * #12549: Add optional ``description`` argument to
:meth:`~sphinx.application.Sphinx.add_config_value`. :meth:`.Sphinx.add_config_value`.
Patch by Chris Sewell. Patch by Chris Sewell.
* #6792: Prohibit module import cycles in :mod:`sphinx.ext.autosummary`. * #6792: Prohibit module import cycles in :mod:`sphinx.ext.autosummary`.
Patch by Trevor Bekolay. Patch by Trevor Bekolay.
* #12508: LaTeX: Revamped styling of all admonitions, with addition of a * #12508: LaTeX: Revamped styling of all admonitions, with addition of a
title row with icon. title row with icon.
Patch by Jean-François B. Patch by Jean-François B.
* #11773: Display :py:class:`~typing.Annotated` annotations * #11773: Display :py:attr:`~typing.Annotated` annotations
with their metadata in the Python domain. with their metadata in the Python domain.
Patch by Adam Turner and David Stansby. Patch by Adam Turner and David Stansby.
* #12506 Add ``level`` option to :rst:dir:`rubric` directive. * #12506: Add ``level`` option to :rst:dir:`rubric` directive.
Patch by Chris Sewell. Patch by Chris Sewell.
* #12567: Add the :event:`write-started` event. * #12567: Add the :event:`write-started` event.
Patch by Chris Sewell. Patch by Chris Sewell.
@ -1556,7 +1556,7 @@ Features added
* #9391: texinfo: improve variable in ``samp`` role * #9391: texinfo: improve variable in ``samp`` role
* #9578: texinfo: Add :confval:`texinfo_cross_references` to disable cross * #9578: texinfo: Add :confval:`texinfo_cross_references` to disable cross
references for readability with standalone readers references for readability with standalone readers
* #9822 (and #9062), add new Intersphinx role :rst:role:`external` for explicit * #9822, #9062: add new Intersphinx role :rst:role:`external` for explicit
lookup in the external projects, without resolving to the local project. lookup in the external projects, without resolving to the local project.
Bugs fixed Bugs fixed
@ -3720,7 +3720,7 @@ Features added
signature signature
* #1063: autodoc: ``automodule`` directive now handles undocumented module level * #1063: autodoc: ``automodule`` directive now handles undocumented module level
variables variables
* #6212 autosummary: Add :confval:`autosummary_imported_members` to display * #6212: autosummary: Add :confval:`autosummary_imported_members` to display
imported members on autosummary imported members on autosummary
* #6271: ``make clean`` is catastrophically broken if building into '.' * #6271: ``make clean`` is catastrophically broken if building into '.'
* #6363: Support ``%O%`` environment variable in make.bat * #6363: Support ``%O%`` environment variable in make.bat
@ -4002,7 +4002,7 @@ Features added
* #4981: C++, added an alias directive for inserting lists of declarations, * #4981: C++, added an alias directive for inserting lists of declarations,
that references existing declarations (e.g., for making a synopsis). that references existing declarations (e.g., for making a synopsis).
* C++: add ``cpp:struct`` to complement ``cpp:class``. * C++: add ``cpp:struct`` to complement ``cpp:class``.
* #1341 the HTML search considers words that contain a search term of length * #1341: the HTML search considers words that contain a search term of length
three or longer a match. three or longer a match.
* #4611: epub: Show warning for duplicated ToC entries * #4611: epub: Show warning for duplicated ToC entries
* #1851: Allow to omit an argument for :rst:dir:`code-block` directive. If * #1851: Allow to omit an argument for :rst:dir:`code-block` directive. If
@ -5341,7 +5341,7 @@ Features added
* #3449: On py3, autodoc use inspect.signature for more accurate signature * #3449: On py3, autodoc use inspect.signature for more accurate signature
calculation. Thanks to Nathaniel J. Smith. calculation. Thanks to Nathaniel J. Smith.
* #3641: Epub theme supports HTML structures that are generated by HTML5 writer. * #3641: Epub theme supports HTML structures that are generated by HTML5 writer.
* #3644 autodoc uses inspect instead of checking types. Thanks to * #3644: autodoc uses inspect instead of checking types. Thanks to
Jeroen Demeyer. Jeroen Demeyer.
* Add a new extension; ``sphinx.ext.imgconverter``. It converts images in the * Add a new extension; ``sphinx.ext.imgconverter``. It converts images in the
document to appropriate format for builders document to appropriate format for builders