#1499: With non-callable setup in a conf.py, now sphinx-build emits
user-friendly error message.
#1502: In autodoc, fix display of parameter defaults containing backslashes.
#1226: autodoc, autosummary: importing setup.py by automodule will invoke
setup process and execute sys.exit(). Now sphinx avoids SystemExit
exception and emits warnings without unexpected termination.
#1503: py:function directive generate incorrectly signature when specifying
a default parameter with an empty list . Thanks to Geert Jansen.
#1508: Non-ASCII filename raise exception on make singlehtml, latex, man,
texinfo and changes.
#1531: On Python3 environment, docutils.conf with ‘source_link=true’ in the
general section cause type error.
PR#270, #1533: Non-ASCII docstring cause UnicodeDecodeError when uses with
inheritance-diagram directive. Thanks to WAKAYAMA shirou.
PR#281, PR#282, #1509: TODO extension not compatible with websupport. Thanks
to Takeshi Komiya.
#1477: gettext does not extract nodes.line in a table or list.
#1544: make text generate wrong table when it has empty table cells.
#1522: Footnotes from table get displayed twice in LaTeX. This problem has
been appeared from Sphinx-1.2.1 by #949.
#508: Sphinx every time exit with zero when is invoked from setup.py command.
ex. python setup.py build_sphinx -b doctest return zero even if doctest
Removed sphinx.util.compat.directive_dwim() and
sphinx.roles.xfileref_role() which were deprecated since version 1.0.
PR#122: the files given in latex_additional_files now override TeX
files included by Sphinx, such as sphinx.sty.
PR#124: the node generated by versionadded,
versionchanged and deprecated directives now includes
all added markup (such as “New in version X”) as child nodes, and no
additional text must be generated by writers.
PR#99: the seealso directive now generates admonition nodes instead
of the custom seealso node.
The toctree directive and the toctree() template function now
have an includehidden option that includes hidden toctree entries (bugs
#790 and #1047). A bug in the maxdepth option for the toctree()
template function has been fixed (bug #1046).
PR#99: Strip down seealso directives to normal admonitions. This removes
their unusual CSS classes (admonition-see-also), inconsistent LaTeX
admonition title (“See Also” instead of “See also”), and spurious indentation
in the text builder.
#783: Create a link to full size image if it is scaled with width or height.
come before matches in full text, and object results are better categorized.
Also implement a pluggable search scorer.
#1053: The “rightsidebar” and “collapsiblesidebar” HTML theme options now work
Update to jQuery 1.7.1 and Underscore.js 1.3.1.
An “Index” node is no longer added when there are no entries.
“deffn” categories are no longer capitalized if they contain capital
desc_annotation nodes are now rendered.
strong and emphasis nodes are now formatted like
literals. The reason for this is because the standard Texinfo markup
(*strong* and _emphasis_) resulted in confusing output due to the
common usage of using these constructs for documenting parameter names.
Field lists formatting has been tweaked to better display
“Info field lists”.
system_message and problematic nodes are now formatted in a similar
fashion as done by the text builder.
“en-dash” and “em-dash” conversion of hyphens is no longer performed in
option directive signatures.
@ref is now used instead of @pxref for cross-references which
prevents the word “see” from being added before the link (does not affect
the Info output).
The @finalout command has been added for better TeX output.
transition nodes are now formatted using underscores (“_”) instead of
The default value for the paragraphindent has been changed from 2 to 0
meaning that paragraphs are no longer indented by default.
#1110: A new configuration value texinfo_no_detailmenu has been
added for controlling whether a @detailmenu is added in the “Top”
Detailed menus are no longer created except for the “Top” node.
Fixed an issue where duplicate domain indices would result in invalid
PR#115: Add 'transition' item in latex_elements for
customizing how transitions are displayed. Thanks to Jeff Klukas.
PR#114: The LaTeX writer now includes the “cmap” package by default. The
'cmappkg' item in latex_elements can be used to control this.
Thanks to Dmitry Shachnev.
The 'fontpkg' item in latex_elements now defaults to ''
when the language uses the Cyrillic script. Suggested by Dmitry
The latex_documents, texinfo_documents, and
man_pages configuration values will be set to default values based
on the master_doc if not explicitly set in conf.py.
Previously, if these values were not set, no output would be genereted by
their respective builders.
Add i18n capabilities for custom templates. For example: The Sphinx
reference documentation in doc directory provides a sphinx.pot file with
message strings from doc/_templates/*.html when using makegettext.
PR#61,#703: Add support for non-ASCII filename handling.
Added the Docutils-native XML and pseudo-XML builders. See
XMLBuilder and PseudoXMLBuilder.
PR#45: The linkcheck builder now checks #anchors for existence.
PR#25: In inheritance diagrams, the first line of the class docstring
is now the tooltip for the class.
PR#75: Added --follow-links option to sphinx-apidoc.
#869: sphinx-build now has the option -T for printing the full
traceback after an unhandled exception.
sphinx-build now supports the standard --help and
sphinx-build now provides more specific error messages when called with
invalid options or arguments.
sphinx-build now has a verbose option -v which can be repeated for
greater effect. A single occurrance provides a slightly more verbose output
than normal. Two or more occurrences of this option provides more detailed
output which may be useful for debugging.
PR#74: Fix some Russian translation.
PR#54: Added Norwegian bokmaal translation.
PR#35: Added Slovak translation.
PR#28: Added Hungarian translation.
#1113: Add Hebrew locale.
#1097: Add Basque locale.
#1037: Fix typos in Polish translation. Thanks to Jakub Wilk.
#1012: Update Estonian translation.
Speed up building the search index by caching the results of the word
stemming routines. Saves about 20 seconds when building the Python
PR#108: Add experimental support for parallel building with a new
Support for domains has been added. A domain is a collection of
directives and roles that all describe objects belonging together,
e.g. elements of a programming language. A few builtin domains are
The old markup for defining and linking to C directives is now
deprecated. It will not work anymore in future versions without
activating the oldcmarkup extension; in Sphinx
1.0, it is activated by default.
Removed support for old dependency versions; requirements are now:
The html_sidebars config value can now contain patterns
as keys, and the values can be lists that explicitly select which
sidebar templates should be rendered. That means that the builtin
sidebar contents can be included only selectively.