Sphinx 8.0.2__tar.gz → 8.1.1__tar.gz

sphinx-8.1.1/AUTHORS.rst

@@ -0,0 +1,107 @@
+Maintainers
+===========
+
+*Listed alphabetically in forename, surname order*
+
+* Adam Turner <@AA-Turner>
+* Bénédikt Tran <@picnixz>
+* Chris Sewell <@chrisjsewell>
+* François Freitag <@francoisfreitag>
+* Jakob Lykke Andersen <@jakobandersen>
+* Jean-François Burnol <@jfbu>
+* Stephen Finucane <@stephenfin>
+* Takayuki Shimizukawa <@shimizukawa>
+* Takeshi Komiya <@tk0miya>
+
+Contributors
+============
+
+*Listed alphabetically in forename, surname order*
+
+* Adrián Chaves (Gallaecio) -- coverage builder improvements
+* Alastair Houghton -- Apple Help builder
+* Alexander Todorov -- inheritance_diagram tests and improvements
+* Andi Albrecht -- agogo theme
+* Antonio Valentino -- qthelp builder, docstring inheritance
+* Antti Kaihola -- doctest extension (skipif option)
+* Barry Warsaw -- setup command improvements
+* Ben Egan -- Napoleon improvements
+* Benjamin Peterson -- unittests
+* Blaise Laflamme -- pyramid theme
+* Bruce Mitchener -- Minor epub improvement
+* Buck Evan -- dummy builder
+* Charles Duffy -- original graphviz extension
+* Chris Lamb -- reproducibility fixes
+* Christopher Perkins -- autosummary integration
+* Dan MacKinlay -- metadata fixes
+* Daniel Bültmann -- todo extension
+* Daniel Neuhäuser -- JavaScript domain, Python 3 support (GSOC)
+* Daniel Pizetta -- inheritance diagram improvements
+* Dave Kuhlman -- original LaTeX writer
+* Doug Hellmann -- graphviz improvements
+* Eric N. Vander Weele -- autodoc improvements
+* Etienne Desautels -- apidoc module
+* Ezio Melotti -- collapsible sidebar JavaScript
+* Filip Vavera -- napoleon todo directive
+* Glenn Matthews -- python domain signature improvements
+* Gregory Szorc -- performance improvements
+* Henrique Bastos -- SVG support for graphviz extension
+* Hernan Grecco -- search improvements
+* Hong Xu -- svg support in imgmath extension and various bug fixes
+* Horst Gutmann -- internationalization support
+* Hugo van Kemenade -- support FORCE_COLOR and NO_COLOR
+* Ian Lee -- quickstart improvements
+* Jacob Mason -- websupport library (GSOC project)
+* Jeppe Pihl -- literalinclude improvements
+* Joel Wurtz -- cellspanning support in LaTeX
+* John Waltman -- Texinfo builder
+* Josip Dzolonga -- coverage builder
+* Julien Palard -- Colspan and rowspan in text builder
+* Kevin Dunn -- MathJax extension
+* KINEBUCHI Tomohiko -- typing Sphinx as well as docutils
+* Kurt McKee -- documentation updates
+* Lars Hupfeldt Nielsen - OpenSSL FIPS mode md5 bug fix
+* Łukasz Langa -- partial support for autodoc
+* Marco Buttu -- doctest extension (pyversion option)
+* Martin Hans -- autodoc improvements
+* Martin Larralde -- additional napoleon admonitions
+* Martin Mahner -- nature theme
+* Matthew Fernandez -- todo extension fix
+* Matthew Woodcraft -- text output improvements
+* Michael Droettboom -- inheritance_diagram extension
+* Michael Wilson -- Intersphinx HTTP basic auth support
+* Nathan Damon -- bugfix in validation of static paths in html builders
+* Pauli Virtanen -- autodoc improvements, autosummary extension
+* A. Rafey Khan -- improved intersphinx typing
+* Rob Ruana -- napoleon extension
+* Robert Lehmann -- gettext builder (GSOC project)
+* Roland Meister -- epub builder
+* Sebastian Wiesner -- image handling, distutils support
+* Stefan Seefeld -- toctree improvements
+* Stefan van der Walt -- autosummary extension
+* T. Powers -- HTML output improvements
+* Taku Shimizu -- epub3 builder
+* Thomas Lamb -- linkcheck builder
+* Thomas Waldmann -- apidoc module fixes
+* Tim Hoffmann -- theme improvements
+* Vince Salvino -- JavaScript search improvements
+* Will Maier -- directory HTML builder
+* Zac Hatfield-Dodds -- doctest reporting improvements, intersphinx performance
+
+Former maintainers
+==================
+
+*Listed alphabetically in forename, surname order*
+
+Former maintainers are those who haven't committed in the last two years.
+Those on the list below may become active maintainers again at any time.
+
+* Armin Ronacher <@mitsuhiko>
+* Daniel Neuhäuser <@DasIch>
+* Georg Brandl <georg@python.org>
+* Rob Ruana <@RobRuana>
+* Robert Lehmann <@lehmannro>
+* Timotheus Kampik <@TimKam>
+* Yoshiki Shibukawa <@shibukawa>
+
+Many thanks for all contributions!

sphinx-8.1.1/CHANGES.rst

@@ -0,0 +1,179 @@
+Release 8.1.1 (released Oct 11, 2024)
+=====================================
+
+Bugs fixed
+----------
+
+* #13006: Use the preferred https://www.cve.org/ URL for
+  the :rst:role:`:cve: <cve>` role.
+  Patch by Hugo van Kemenade.
+* #13007: LaTeX: Improve resiliency when the required
+  ``fontawesome`` or ``fontawesome5`` packages are not installed.
+  Patch by Jean-François B.
+
+
+Release 8.1.0 (released Oct 10, 2024)
+=====================================
+
+Dependencies
+------------
+
+* #12756: Add lower-bounds to the ``sphinxcontrib-*`` dependencies.
+  Patch by Adam Turner.
+* #12833: Update the LaTeX ``parskip`` package from 2001 to 2018.
+  Patch by Jean-François B.
+
+Incompatible changes
+--------------------
+
+* #12763: Remove unused internal class ``sphinx.util.Tee``.
+  Patch by Adam Turner.
+* #12822: LaTeX: for Unicode engines, the :ref:`fvset` default is changed to
+  ``'\\fvset{fontsize=auto}'`` from ``'\\fvset{fontsize=\\small}'``.
+  Code-blocks are unchanged as FreeMono is now loaded with ``Scale=0.9``.
+  An adjustment to existing projects is needed only if they used a custom
+  :ref:`fontpkg` configuration and did not set :ref:`fvset`.
+  Patch by Jean-François B.
+* #12875: Disable smartquotes for languages: ``zh_CN`` and ``zh_TW`` by default.
+  Patch by A. Rafey Khan.
+
+Deprecated
+----------
+
+* #12762: Deprecate ``sphinx.util.import_object``.
+  Use :py:func:`importlib.import_module` instead.
+  Patch by Adam Turner.
+* #12766: Deprecate ``sphinx.util.FilenameUniqDict``
+  and ``sphinx.util.DownloadFiles``.
+  Patch by Adam Turner.
+
+Features added
+--------------
+
+* #11328: Mention evaluation of templated content during production of static
+  output files.
+  Patch by James Addison.
+* #12704: LaTeX: make :dudir:`contents <table-of-contents>`, :dudir:`topic`,
+  and :dudir:`sidebar` directives separately customizable for PDF output.
+  Patch by Jean-François B. and Bénédikt Tran.
+* #12474: Support type-dependent search result highlighting via CSS.
+  Patch by Tim Hoffmann.
+* #12652: LaTeX: Add :confval:`math_numsep` support to latex builder.
+  Patch by Thomas Fanning and Jean-François B.
+* #12743: No longer exit on the first warning when
+  :option:`--fail-on-warning <sphinx-build --fail-on-warning>` is used.
+  Instead, exit with a non-zero status if any warnings were generated
+  during the build.
+  Patch by Adam Turner.
+* #12743: Add :option:`sphinx-build --exception-on-warning`,
+  to raise an exception when warnings are emitted during the build.
+  Patch by Adam Turner and Jeremy Maitin-Shepard.
+* #12907: Add :confval:`html_last_updated_use_utc` to allow using
+  universal time (GMT/UTC) instead of local time for the date-time
+  supplied to :confval:`html_last_updated_fmt`.
+  Patch by Adam Turner.
+* #12910: Copyright entries now support the ``'%Y'`` placeholder
+  to substitute the current year.
+  This is helpful for reducing the reliance on Python modules
+  such as :py:mod:`time` or :py:mod:`datetime` in :file:`conf.py`.
+  See :ref:`the docs <config-copyright>` for further detail.
+  Patch by Adam Turner.
+* #11781: Add roles for referencing CVEs (:rst:role:`:cve: <cve>`)
+  and CWEs (:rst:role:`:cwe: <cwe>`).
+  Patch by Hugo van Kemenade.
+* #11809: Improve the formatting for RFC section anchors.
+  Patch by Jakub Stasiak and Adam Turner.
+* #12852: Support a :attr:`.Builder.supported_linkcode` attribute
+  for builders to enable use of :mod:`sphinx.ext.linkcode`-generated
+  references.
+  Patch by James Knight.
+* #12949: Print configuration options that differ from the pickled environment.
+  This can be helpful in diagnosing the cause of a full rebuild.
+  Patch by Adam Turner.
+
+Bugs fixed
+----------
+
+* #12514: intersphinx: fix the meaning of a negative value for
+  :confval:`intersphinx_cache_limit`.
+  Patch by Shengyu Zhang.
+* #12722: LaTeX: avoid TeX reporting ``Overfull \hbox`` from too long
+  strings in a codeline when the problem has actually been solved thanks
+  to :ref:`latexsphinxsetupforcewraps`.
+  Patch by Jean-François B.
+* #12730: The ``UnreferencedFootnotesDetector`` transform has been improved
+  to more consistently detect unreferenced footnotes.
+  Note, the priority of the transform has been changed from 200 to 622,
+  so that it now runs after the docutils ``Footnotes`` resolution transform.
+  Patch by Chris Sewell.
+* #12778: LaTeX: let :ref:`'sphinxsetup' <latexsphinxsetup>`
+  ``div.topic_box-shadow`` key if used with only one dimension set both
+  x-offset and y-offset as per documentation.
+  Patch by Jean-François B.
+* #12587: Do not warn when potential ambiguity detected during Intersphinx
+  resolution occurs due to duplicate targets that differ case-insensitively.
+  Patch by James Addison.
+* #12639: Fix singular and plural search results text.
+  Patch by Hugo van Kemenade.
+* #12645: Correctly support custom gettext output templates.
+  Patch by Jeremy Bowman.
+* #12717: LaTeX: let :option:`-q <sphinx-build -q>` (quiet) option for
+  :program:`sphinx-build -M latexpdf` or :program:`make latexpdf` (``O=-q``)
+  get passed to :program:`latexmk`.  Let :option:`-Q <sphinx-build -Q>`
+  (silent) apply as well to the PDF build phase.
+  Patch by Jean-François B.
+* #12744: LaTeX: Classes injected by a custom interpreted text role now give
+  rise to nested ``\DUrole``'s, rather than a single one with comma separated
+  classes.
+  Patch by Jean-François B.
+* #12831: LaTeX: avoid large voids sometimes occurring at page bottoms.
+  Patch by Jean-François B.
+* #11970, #12551: singlehtml builder: make target URIs to be same-document
+  references in the sense of :rfc:`RFC 3986, §4.4 <3986#section-4.4>`,
+  e.g., ``index.html#foo`` becomes ``#foo``.
+  (note: continuation of a partial fix added in Sphinx 7.3.0)
+  Patch by James Addison (with reference to prior work by Eric Norige).
+* #12735: Fix :pep:`695` generic classes LaTeX output formatting.
+  Patch by Jean-François B. and Bénédikt Tran.
+* #12782: intersphinx: fix double forward slashes when generating the inventory
+  file URL (user-defined base URL of an intersphinx project are left untouched
+  even if they end with double forward slashes).
+  Patch by Bénédikt Tran.
+* #12796: Enable parallel reading if requested,
+  even if there are fewer than 6 documents.
+  Patch by Matthias Geier.
+* #12844: Restore support for ``:noindex:`` for the :rst:dir:`js:module`
+  and :rst:dir:`py:module` directives.
+  Patch by Stephen Finucane.
+* #12916: Restore support for custom templates named with the legacy ``_t``
+  suffix during ``apidoc`` RST rendering (regression in 7.4.0).
+  Patch by James Addison.
+* #12451: Only substitute copyright notice years with values from
+  ``SOURCE_DATE_EPOCH`` for entries that match the current system clock year,
+  and disallow substitution of future years.
+  Patch by James Addison and Adam Turner.
+* #12905: intersphinx: fix flipped use of :confval:`intersphinx_cache_limit`,
+  which always kept the cache for positive values, and always refreshed it for
+  negative ones.
+  Patch by Nico Madysa.
+* #12888: Add a warning when document is included in multiple toctrees
+  and ensure deterministic resolution of global toctree in parallel builds
+  by choosing the lexicographically greatest parent document.
+  Patch by A. Rafey Khan
+* #12995: Significantly improve performance when building the search index
+  for Chinese languages.
+  Patch by Adam Turner.
+* #12767: :py:meth:`.Builder.write` is typed as ``final``, meaning that the
+  :event:`write-started` event may be relied upon by extensions.
+  A new :py:meth:`.Builder.write_documents` method has been added to
+  control how documents are written.
+  This is intended for builders that do not output a file for each document.
+  Patch by Adam Turner.
+
+
+Testing
+-------
+
+* #12141: Migrate from the deprecated ``karma`` JavaScript test framework to
+  the actively-maintained ``jasmine`` framework.  Test coverage is unaffected.
+  Patch by James Addison.