Sphinx Versions Summary#

On this page, we’ll summarize a few recent Sphinx releases. We don’t want to duplicate the official Sphinx changelogs, but briefly highlight the most important changes and list supported Python and Docutils versions.

At Documatt, we develop a lot of custom Sphinx themes, Sphinx extensions, and our flagship product is based on Sphinx. The following changelog summaries are useful for us, and we hope they will help other Sphinx theme and extension authors too.

The primary Sphinx dependency is Docutils. Consult the Docutils changelog as well.

Sphinx Releases#

Summary from 6.0.0 to the newest. The Major.minor number is a link to the Sphinx changelog.

Major.minor version

Latest patch

Patch release

Supported Python

Supported Docutils

Highlights

8.1.x

8.1.3

2024-10-13

>= 3.10

>=0.20 <0.22

  • -W/--fail-on-warning is no longer “fast-fail” but performs a normal build and exits with non-zero in case of warnings.

  • Raise exception on warning (gives real traceback).

  • Allow %Y for dynamic year in copyright.

  • A lot of LaTeX improvements and bug fixes.

8.0.x

8.0.2

2024-07-30

>= 3.10

>=0.20 <0.22

7.4.x

7.4.7

2024-07-20

>= 3.9

>=0.20 <0.22

  • Add .jinja extension support for template files.

  • Add confval directive.

  • Add heading-level option to the rubric directive.

  • A lot of breaking changes in the Sphinx API.

  • A lot of bug fixes.

7.3.x

7.3.7

2024-04-19

>= 3.9

>=0.18.1 <0.22

  • Improve compatibility with the Furo theme.

  • Start deprecating the old-style Makefile.

  • Theme configuration via theme.toml.

  • Use HTML <search> element.

  • Add versionremoved directive.

  • Add show_warning_types configuration option.

  • A lot of bug fixes.

7.2.x

7.2.6

2023-09-13

>= 3.9

>=0.18.1 <0.21

  • Deprecate the old style of adding JS and CSS files in favor of the sphinx.application.Sphinx.add_css_file() and sphinx.application.Sphinx.add_js_file() methods.

  • Allow running Sphinx with python -m sphinx build ....

7.1.x

7.1.2

2023-08-02

>= 3.8

>=0.18.1 <0.21

  • Add checksum to URLs for JS and CSS files in HTML output (e.g., _static/output.css?v=a7330216).

  • Multiline copyright statements in the footer.

7.0.x

7.0.1

2023-05-12

>= 3.8

>=0.18.1 <0.21

  • Drop outputting to HTML4.

  • A lot of breaking changes in the Sphinx API.

6.2.x

6.2.1

2023-04-25

>= 3.8

>=0.18.1 <0.20

  • A lot of bug fixes in LaTeX output.

6.1.x

6.1.3

2023-01-10

>= 3.8

>=0.18 <0.20

6.0.x

6.0.1

2023-01-10

>= 3.8

>=0.18 <0.20

  • Remove injecting jQuery and underscore.js into themes.

Documatt Sphinx#

Currently, the Documatt app supports Sphinx 6.2.1 only.

Sphinx version

Available from-to

6.2.1

2024-03-01 - now

Comments

comments powered by Disqus