Changelog¶
Release 8.1.0 (in development)¶
Dependencies¶
#12756: Add lower-bounds to the
sphinxcontrib-*dependencies. Patch by Adam Turner.
Incompatible changes¶
#12763: Remove unused internal class
sphinx.util.Tee. Patch by Adam Turner.
Deprecated¶
#12762: Deprecate
sphinx.util.import_object. Useimportlib.import_module()instead. Patch by Adam Turner.#12766: Deprecate
sphinx.util.FilenameUniqDictandsphinx.util.DownloadFiles. Patch by Adam Turner.
Features added¶
#11328: Mention evaluation of templated content during production of static output files.
#12474: Support type-dependent search result highlighting via CSS. Patch by Tim Hoffmann.
#12743: No longer exit on the first warning when
--fail-on-warningis used. Instead, exit with a non-zero status if any warnings were generated during the build. Patch by Adam Turner.#12743: Add
sphinx-build --exception-on-warning, to raise an exception when warnings are emitted during the build. Patch by Adam Turner and Jeremy Maitin-Shepard.
Bugs fixed¶
#12514: intersphinx: fix the meaning of a negative value for
intersphinx_cache_limit. Patch by Shengyu Zhang.#12730: The
UnreferencedFootnotesDetectortransform 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 docutilsFootnotesresolution transform. Patch by Chris Sewell.#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
-q(quiet) option for sphinx-build -M latexpdf or make latexpdf (O=-q) get passed to latexmk. Let-Q(silent) apply as well to the PDF build phase. Patch by Jean-François B.#11970, #12551: singlehtml builder: make target URIs to be same-document references in the sense of RFC 3986, §4.4, e.g.,
index.html#foobecomes#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)
Testing¶
#12141: Migrate from the deprecated
karmaJavaScript test framework to the actively-maintainedjasmineframework. Test coverage is unaffected. Patch by James Addison.
Prior releases¶
- Sphinx 8.0
- Sphinx 7.4
- Release 7.4.7 (released Jul 20, 2024)
- Release 7.4.6 (released Jul 18, 2024)
- Release 7.4.5 (released Jul 16, 2024)
- Release 7.4.4 (released Jul 15, 2024)
- Release 7.4.3 (released Jul 15, 2024)
- Release 7.4.2 (released Jul 15, 2024)
- Release 7.4.1 (released Jul 15, 2024)
- Release 7.4.0 (released Jul 15, 2024)
- Sphinx 7.3
- Release 7.3.7 (released Apr 19, 2024)
- Release 7.3.6 (released Apr 17, 2024)
- Release 7.3.5 (released Apr 17, 2024)
- Release 7.3.4 (released Apr 17, 2024)
- Release 7.3.3 (released Apr 17, 2024)
- Release 7.3.2 (released Apr 17, 2024)
- Release 7.3.1 (released Apr 17, 2024)
- Release 7.3.0 (released Apr 16, 2024)
- Sphinx 7.2
- Sphinx 7.1
- Sphinx 7.0
- Sphinx 6.2
- Sphinx 6.1
- Sphinx 6.0
- Sphinx 5.3
- Sphinx 5.2
- Sphinx 5.1
- Sphinx 5.0
- Sphinx 4.5
- Sphinx 4.4
- Sphinx 4.3
- Sphinx 4.2
- Sphinx 4.1
- Sphinx 4.0
- Sphinx 3.5
- Sphinx 3.4
- Sphinx 3.3
- Sphinx 3.2
- Sphinx 3.1
- Sphinx 3.0
- Sphinx 2.4
- Sphinx 2.3
- Sphinx 2.2
- Sphinx 2.1
- Sphinx 2.0
- Sphinx 1.8
- Sphinx 1.7
- Release 1.7.9 (released Sep 05, 2018)
- Release 1.7.8 (released Aug 29, 2018)
- Release 1.7.7 (released Aug 19, 2018)
- Release 1.7.6 (released Jul 17, 2018)
- Release 1.7.5 (released May 29, 2018)
- Release 1.7.4 (released Apr 25, 2018)
- Release 1.7.3 (released Apr 23, 2018)
- Release 1.7.2 (released Mar 21, 2018)
- Release 1.7.1 (released Feb 23, 2018)
- Release 1.7.0 (released Feb 12, 2018)
- Sphinx 1.6
- Sphinx 1.5
- Sphinx 1.4
- Release 1.4.9 (released Nov 23, 2016)
- Release 1.4.8 (released Oct 1, 2016)
- Release 1.4.7 (released Oct 1, 2016)
- Release 1.4.6 (released Aug 20, 2016)
- Release 1.4.5 (released Jul 13, 2016)
- Release 1.4.4 (released Jun 12, 2016)
- Release 1.4.3 (released Jun 5, 2016)
- Release 1.4.2 (released May 29, 2016)
- Release 1.4.1 (released Apr 12, 2016)
- Release 1.4 (released Mar 28, 2016)
- Sphinx 1.3
- Release 1.3.6 (released Feb 29, 2016)
- Release 1.3.5 (released Jan 24, 2016)
- Release 1.3.4 (released Jan 12, 2016)
- Release 1.3.3 (released Dec 2, 2015)
- Release 1.3.2 (released Nov 29, 2015)
- Release 1.3.1 (released Mar 17, 2015)
- Release 1.3 (released Mar 10, 2015)
- Release 1.3b3 (released Feb 24, 2015)
- Release 1.3b2 (released Dec 5, 2014)
- Release 1.3b1 (released Oct 10, 2014)
- Sphinx 1.2
- Sphinx 1.1
- Sphinx 1.0
- Sphinx 0.6
- Sphinx 0.5
- Sphinx 0.4
- Sphinx 0.3
- Sphinx 0.2
- Sphinx 0.1