Sphinx v3.1.1 Release Notes

Release Date: 2020-06-14 // almost 4 years ago

Previous changes from v1.3.b3

  • Incompatible changes

    • โšก๏ธ Dependency requirement updates: docutils 0.11, Pygments 2.0
    • The gettext_enables config value has been renamed to gettext_additional_targets.
    • ๐Ÿ“„ #1735: Use https://docs.python.org/ instead of http protocol. It was used for sphinx.ext.intersphinx and some documentation.

    ๐Ÿ”‹ Features added

    • 0๏ธโƒฃ #1346: Add new default theme;

      • Add 'alabaster' theme.
      • Add 'sphinx_rtd_theme' theme.
      • The 'default' html theme has been renamed to 'classic'. 'default' is still available, however it will emit notice a recommendation that using new 'alabaster' theme.
    • โž• Added highlight_options configuration value.

    • The language config value is now available in the HTML templates.

    • โšก๏ธ The env-updated event can now return a value, which is interpreted as an iterable of additional docnames that need to be rewritten.

    • ๐Ÿ‘ #772: Support for scoped and unscoped enums in C++. Enumerators in unscoped enums are injected into the parent scope in addition to the enum scope.

    • Add todo_include_todos config option to quickstart conf file, handled as described in documentation.

    • HTML breadcrumb items tag has class "nav-item" and "nav-item-N" (like nav-item-0, 1, 2...).

    • ๐Ÿ†• New option sphinx-quickstart --use-make-mode for generating Makefile that use sphinx-build make-mode.

    • 1235: i18n: several node can be translated if it is set to

      gettext_additional_targets in conf.py. Supported nodes are:

      • 'literal-block'
      • 'doctest-block'
      • 'raw'
      • 'image'
    • 1227: Add html_scaled_image_link config option to conf.py, to control

      scaled image link.

    ๐Ÿ› Bugs fixed

    • LaTeX writer now generates correct markup for cells spanning multiple rows.
    • #1674: Do not crash if a module's __all__ is not a list of strings.
    • #1629: Use VerbatimBorderColor to add frame to code-block in LaTeX
    • ๐Ÿ On windows, make-mode didn't work on Win32 platform if sphinx was invoked as python sphinx-build.py.
    • #1687: linkcheck now treats 401 Unauthorized responses as "working".
    • #1690: toctrees with glob option now can also contain entries for single documents with explicit title.
    • #1591: html search results for C++ elements now has correct interpage links.
    • ๐Ÿ’… bizstyle theme: nested long title pages make long breadcrumb that breaks page layout.
    • ๐Ÿ’… bizstyle theme: all breadcrumb items become 'Top' on some mobile browser (iPhone5s safari).
    • โช #1722: restore toctree() template function behavior that was changed at 1.3b1.
    • ๐Ÿ‘ป #1732: i18n: localized table caption raises exception.
    • #1718: :numref: does not work with capital letters in the label
    • #1630: resolve CSS conflicts, div.container css target for literal block wrapper now renamed to div.literal-block-wrapper.
    • โช sphinx.util.pycompat has been restored in its backwards-compatibility; slated for removal in Sphinx 1.4.
    • #1719: LaTeX writer does not respect numref_format option in captions