Sphinx v3.1.1 Release Notes
Release Date: 2020-06-14 // almost 5 years ago-
No data yet ๐
You can check the official repo
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 togettext_additional_targets
. - ๐ #1735: Use https://docs.python.org/ instead of
http
protocol. It was used forsphinx.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 controlscaled 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 todiv.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