sphinx-8.1.3

[Bruce Dubbs]

New point version.

[Bruce Dubbs]

Release 8.1.0 (released Oct 10, 2024) Dependencies

• Add lower-bounds to the sphinxcontrib-* dependencies.
• Update the LaTeX parskip package from 2001 to 2018.

Incompatible changes

• Remove unused internal class sphinx.util.Tee.
• 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.
• Disable smartquotes for languages: zh_CN and zh_TW by default.

Deprecated

• Deprecate sphinx.util.import_object. Use :py:func:`importlib.import_module` instead.
• Deprecate sphinx.util.FilenameUniqDict and sphinx.util.DownloadFiles.

Features added

• Mention evaluation of templated content during production of static output files.
• LaTeX: make :dudir:contents <table-of-contents>, :dudir:topic, and :dudir:sidebar directives separately customizable for PDF output.
• Support type-dependent search result highlighting via CSS.
• LaTeX: Add :confval:math_numsep support to latex builder.
• 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.
• Add :option:sphinx-build --exception-on-warning, to raise an exception when warnings are emitted during the build.
• 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.
• 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.
• Add roles for referencing CVEs (:rst:role:`:cve: <cve>`) and CWEs (:rst:role:`:cwe: <cwe>`).
• Improve the formatting for RFC section anchors.
• Support a :attr:.Builder.supported_linkcode attribute for builders to enable use of :mod:sphinx.ext.linkcode-generated references.
• Print configuration options that differ from the pickled environment. This can be helpful in diagnosing the cause of a full rebuild.

Bugs fixed

• intersphinx: fix the meaning of a negative value for :confval:intersphinx_cache_limit.
• LaTeX: avoid TeX reporting Overfull \hbox from too long strings in a codeline when the problem has actually been solved thanks to :ref:latexsphinxsetupforcewraps.
• 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.
• 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.
• Do not warn when potential ambiguity detected during Intersphinx resolution occurs due to duplicate targets that differ case-insensitively.
• Fix singular and plural search results text.
• Correctly support custom gettext output templates.
• 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.
• 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.
• LaTeX: avoid large voids sometimes occurring at page bottoms.
• 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)
• Fix :pep:695 generic classes LaTeX output formatting.
• 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).
• Enable parallel reading if requested, even if there are fewer than 6 documents.
• Restore support for :noindex: for the :rst:dir:`js:module` and :rst:dir:`py:module` directives.
• Restore support for custom templates named with the legacy _t suffix during apidoc RST rendering (regression in 7.4.0).
• 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.
• intersphinx: fix flipped use of :confval:intersphinx_cache_limit, which always kept the cache for positive values, and always refreshed it for negative ones.
• 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.
• Significantly improve performance when building the search index for Chinese languages.
• :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.

Testing

• Migrate from the deprecated karma JavaScript test framework to the actively-maintained jasmine framework. Test coverage is unaffected.

[Bruce Dubbs]

Fixed at commits

53836892db Update to gtksourceview-5.14.1.
b73aa5e8a8 Update to git-2.47.0.
497eca1fdc Update to URI-5.30 (Perl Module).
b3bc61f345 Update to SPIRV-Headers and SPIRV-Tools-1.3.296.0.
003bc0cb4a Update to sentry_sdk-2.16.0 (Python Module).
6d4313af02 Update to sphinx-8.1.0 (Python Module).
4f4eab088c Update to sphinx_rtd_theme-3.0.1 (Python Module).

[Bruce Dubbs]

Now version 8.1.3.

[Bruce Dubbs]

Release 8.1.3 (released Oct 13, 2024)

Bugs fixed

• Restore support for :func:!cut_lines with no object type.

Release 8.1.2 (released Oct 12, 2024)

Bugs fixed

• Expose :exc:sphinx.errors.ExtensionError in sphinx.util for backwards compatibility. This will be removed in Sphinx 9, as exposing the exception in sphinx.util was never intentional. :exc:!ExtensionError has been part of sphinx.errors since Sphinx 0.9.

Release 8.1.1 (released Oct 11, 2024)

Bugs fixed

• Use the preferred ​https://www.cve.org/ URL for the :rst:role:`:cve: <cve>` role.
• LaTeX: Improve resiliency when the required fontawesome or fontawesome5 packages are not installed.

[Bruce Dubbs]

Fixed at commit 59a82b1c15.