#1335: Fix autosummary template overloading with exclamation prefix like
{%extends"!autosummary/class.rst"%} cause infinite recursive function
call. This was caused by PR#181.
#1337: Fix autodoc with autoclass_content="both" uses useless
object.__init__ docstring when class does not have __init__.
This was caused by a change for #1138.
#1340: Can’t search alphabetical words on the HTML quick search generated
with language=’ja’.
#1319: Do not crash if the html_logo file does not exist.
#603: Do not use the HTML-ized title for building the search index (that
resulted in “literal” being found on every page with a literal in the
title).
#751: Allow production lists longer than a page in LaTeX by using longtable.
#764: Always look for stopwords lowercased in JS search.
#814: autodoc: Guard against strange type objects that don’t have
__bases__.
#932: autodoc: Do not crash if __doc__ is not a string.
#933: Do not crash if an option value is malformed (contains
spaces but no option name).
#908: On Python 3, handle error messages from LaTeX correctly in the pngmath
extension.
#943: In autosummary, recognize “first sentences” to pull from the docstring
if they contain uppercase letters.
#923: Take the entire LaTeX document into account when caching
pngmath-generated images. This rebuilds them correctly when
pngmath_latex_preamble changes.
#901: Emit a warning when using docutils’ new “math” markup without a Sphinx
math extension active.
#845: In code blocks, when the selected lexer fails, display line numbers
nevertheless if configured.
#929: Support parsed-literal blocks in LaTeX output correctly.
#949: Update the tabulary.sty packed with Sphinx.
#1050: Add anonymous labels into objects.inv to be referenced via
intersphinx.
#1095: Fix print-media stylesheet being included always in the “scrolls”
theme.
#1085: Fix current classname not getting set if class description has
:noindex: set.
#1181: Report option errors in autodoc directives more gracefully.
#1155: Fix autodocumenting C-defined methods as attributes in Python 3.
#1233: Allow finding both Python classes and exceptions with the “class” and
“exc” roles in intersphinx.
#1198: Allow “image” for the “figwidth” option of the figure
directive as documented by docutils.
#1152: Fix pycode parsing errors of Python 3 code by including two grammar
versions for Python 2 and 3, and loading the appropriate version for the
running Python version.
#1017: Be helpful and tell the user when the argument to option
does not match the required format.
#1345: Fix two bugs with nitpick_ignore; now you don’t have to
remove the store environment for changes to have effect.
#1072: In the JS search, fix issues searching for upper-cased words by
lowercasing words before stemming.
#1299: Make behavior of the math directive more consistent and
avoid producing empty environments in LaTeX output.
#1308: Strip HTML tags from the content of “raw” nodes before feeding it
to the search indexer.
#1249: Fix duplicate LaTeX page numbering for manual documents.
#1292: In the linkchecker, retry HEAD requests when denied by HTTP 405.
Also make the redirect code apparent and tweak the output a bit to be
more obvious.
#1285: Avoid name clashes between C domain objects and section titles.
#848: Always take the newest code in incremental rebuilds with the
sphinx.ext.viewcode extension.
#979, #1266: Fix exclude handling in sphinx-apidoc.
Restore versionmodified CSS class for versionadded/changed and deprecated
directives.
PR#181: Fix html_theme_path=[‘.’] is a trigger of rebuild all documents
always (This change keeps the current “theme changes cause a rebuild”
feature).
#1296: Fix invalid charset in HTML help generated HTML files for default
locale.
PR#190: Fix gettext does not extract figure caption and rubric title inside
other blocks. Thanks to Michael Schlenker.
PR#176: Make sure setup_command test can always import Sphinx. Thanks to
Dmitry Shachnev.
#1311: Fix test_linkcode.test_html fails with C locale and Python 3.
#1269: Fix ResourceWarnings with Python 3.2 or later.
#1138: Fix: When autodoc_docstring_signature=True and
autoclass_content='init' or 'both', __init__ line should be
removed from class documentation.
PR#154: Remove “sphinx” prefix from LaTeX class name except ‘sphinxmanual’
and ‘sphinxhowto’. Now you can use your custom document class without
‘sphinx’ prefix. Thanks to Erik B.
#1265: Fix i18n: crash when translating a section name that is pointed to from
a named target.
A wrong condition broke the search feature on first page that is usually
index.rst. This issue was introduced in 1.2b1.
#703: When Sphinx can’t decode filenames with non-ASCII characters, Sphinx now
catches UnicodeError and will continue if possible instead of raising the
exception.
apidoc now ignores “_private” modules by default, and has an option -P
to include them.
apidoc now has an option to not generate headings for packages and
modules, for the case that the module docstring already includes a reST
heading.
PR#161: apidoc can now write each module to a standalone page instead of
combining all modules in a package on one page.
Builders: rebuild i18n target document when catalog updated.
Support docutils.conf ‘writers’ and ‘html4css1 writer’ section in the HTML
writer. The latex, manpage and texinfo writers also support their respective
‘writers’ sections.
The new html_extra_path config value allows to specify directories
with files that should be copied directly to the HTML output directory.
Autodoc directives for module data and attributes now support an
annotation option, so that the default display of the data/attribute
value can be overridden.
PR#136: Autodoc directives now support an imported-members option to
include members imported from different modules.
New locales: Macedonian, Sinhala, Indonesian.
Theme package collection by using setuptools plugin mechanism.
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.
HTML builder
#783: Create a link to full size image if it is scaled with width or height.
#1067: Improve the ordering of the JavaScript search results: matches in titles
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
together.
Update to jQuery 1.7.1 and Underscore.js 1.3.1.
Texinfo builder
An “Index” node is no longer added when there are no entries.
“deffn” categories are no longer capitalized if they contain capital
letters.
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
asterisks (“*”).
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”
node’s menu.
Detailed menus are no longer created except for the “Top” node.
Fixed an issue where duplicate domain indices would result in invalid
output.
LaTeX builder:
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
Shachnev.
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.
Internationalization:
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.
Other builders:
Added the Docutils-native XML and pseudo-XML builders. See
XMLBuilder and PseudoXMLBuilder.
PR#45: The linkcheck builder now checks #anchors for existence.
PR#123, #1106: Add epub_use_index configuration value. If
provided, it will be used instead of html_use_index for epub
builder.
PR#126: Add epub_tocscope configuration value. The setting
controls the generation of the epub toc. The user can now also include
hidden toc entries.
PR#25: In inheritance diagrams, the first line of the class docstring
is now the tooltip for the class.
Command-line interfaces:
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
--version options.
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.
Locales:
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.
Optimizations:
Speed up building the search index by caching the results of the word
stemming routines. Saves about 20 seconds when building the Python
documentation.
PR#108: Add experimental support for parallel building with a new
-j option.
PR#124: Fix paragraphs in versionmodified are ignored when it has no
dangling paragraphs. Fix wrong html output (nested <p> tag). Fix
versionmodified is not translatable. Thanks to Nozomu Kaneko.
PR#111: Respect add_autodoc_attrgetter() even when inherited-members is set.
Thanks to A. Jesse Jiryu Davis.
PR#97: Fix footnote handling in translated documents.
Fix text writer not handling visit_legend for figure directive contents.
Fix text builder not respecting wide/fullwidth characters: title underline
width, table layout width and text wrap width.
Fix leading space in LaTeX table header cells.
#1132: Fix LaTeX table output for multi-row cells in the first column.
#1128: Fix Unicode errors when trying to format time strings with a
non-standard locale.
#1127: Fix traceback when autodoc tries to tokenize a non-Python file.
#1126: Fix double-hyphen to en-dash conversion in wrong places such as
command-line option names in LaTeX.
#1123: Allow whitespaces in filenames given to literalinclude.
#1120: Added improvements about i18n for themes “basic”, “haiku” and
“scrolls” that Sphinx built-in. Thanks to Leonardo J. Caballero G.
#1118: Updated Spanish translation. Thanks to Leonardo J. Caballero G.
#1117: Handle .pyx files in sphinx-apidoc.
#1112: Avoid duplicate download files when referenced from documents in
different ways (absolute/relative).
#1111: Fix failure to find uppercase words in search when
html_search_language is ‘ja’. Thanks to Tomo Saito.
#1108: The text writer now correctly numbers enumerated lists with
non-default start values (based on patch by Ewan Edwards).
#1102: Support multi-context “with” statements in autodoc.
#1090: Fix gettext not extracting glossary terms.
#1074: Add environment version info to the generated search index to avoid
compatibility issues with old builds.
#1070: Avoid un-pickling issues when running Python 3 and the saved
environment was created under Python 2.
#1069: Fixed error caused when autodoc would try to format signatures of
“partial” functions without keyword arguments (patch by Artur Gaspar).
#1062: sphinx.ext.autodoc use __init__ method signature for class signature.
#1055: Fix web support with relative path to source directory.
#1043: Fix sphinx-quickstart asking again for yes/no questions because
input() returns values with an extra ‘r’ on Python 3.2.0 +
Windows. Thanks to Régis Décamps.
#1041: Fix failure of the cpp domain parser to parse a const type with a
modifier.
#1038: Fix failure of the cpp domain parser to parse C+11 “static constexpr”
declarations. Thanks to Jakub Wilk.
#1029: Fix intersphinx_mapping values not being stable if the mapping has
plural key/value set with Python 3.3.
#1028: Fix line block output in the text builder.
#1024: Improve Makefile/make.bat error message if Sphinx is not found. Thanks
to Anatoly Techtonik.
#1018: Fix “container” directive handling in the text builder.
#1015: Stop overriding jQuery contains() in the JavaScript.
#1010: Make pngmath images transparent by default; IE7+ should handle it.
#1008: Fix test failures with Python 3.3.
#995: Fix table-of-contents and page numbering for the LaTeX “howto” class.
#976: Fix gettext does not extract index entries.
PR#72: #975: Fix gettext not extracting definition terms before docutils 0.10.
#961: Fix LaTeX output for triple quotes in code snippets.
#958: Do not preserve environment.pickle after a failed build.
#955: Fix i18n transformation.
#940: Fix gettext does not extract figure caption.
#920: Fix PIL packaging issue that allowed to import Image without PIL
namespace. Thanks to Marc Schlaich.
#723: Fix the search function on local files in WebKit based browsers.
#440: Fix coarse timestamp resolution in some filesystem generating a wrong
list of outdated files.
The py:module directive doesn’t output its platform option
value anymore. (It was the only thing that the directive did output, and
therefore quite inconsistent.)
Removed support for old dependency versions; requirements are now:
#472: linkcheck builder: Check links in parallel, use HTTP HEAD
requests and allow configuring the timeout. New config values:
linkcheck_timeout and linkcheck_workers.
Application.add_stylesheet() now accepts full URIs.
Autodoc:
#564: Add autodoc_docstring_signature. When enabled (the
default), autodoc retrieves the signature from the first line of the
docstring, if it is found there.
#176: Provide private-members option for autodoc directives.
#520: Provide special-members option for autodoc directives.
#431: Doc comments for attributes can now be given on the same line
as the assignment.
#437: autodoc now shows values of class data attributes.
autodoc now supports documenting the signatures of
functools.partial objects.
#581: Fix traceback in Python domain for empty cross-reference
targets.
#283: Fix literal block display issues on Chrome browsers.
#383, #148: Support sorting a limited range of accented characters
in the general index and the glossary.
#570: Try decoding -D and -A command-line arguments with
the locale’s preferred encoding.
#528: Observe locale_dirs when looking for the JS
translations file.
#574: Add special code for better support of Japanese documents
in the LaTeX builder.
Regression of #77: If there is only one parameter given with
:param: markup, the bullet list is now suppressed again.
#556: Fix missing paragraph breaks in LaTeX output in certain
situations.
#567: Emit the autodoc-process-docstring event even for objects
without a docstring so that it can add content.
#565: In the LaTeX builder, not only literal blocks require different
table handling, but also quite a few other list-like block elements.
#515: Fix tracebacks in the viewcode extension for Python objects
that do not have a valid signature.
Fix strange reportings of line numbers for warnings generated from
autodoc-included docstrings, due to different behavior depending
on docutils version.
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
provided:
Python
C
C++
JavaScript
reStructuredText
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:
Added html_compact_lists config value to control
docutils’ compact lists feature.
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.
The behavior of html_file_suffix changed slightly: the
empty string now means “no suffix” instead of “default suffix”, use
None for “default suffix”.
New builders:
Added a builder for the Epub format.
Added a builder for manual pages.
Added a single-file HTML builder.
HTML output:
Inline roles now get a CSS class with their name, allowing styles to
customize their appearance. Domain-specific roles get two classes,
domain and domain-rolename.
References now get the class internal if they are internal to
the whole project, as opposed to internal to the current page.
External references can be styled differently with the new
externalrefs theme option for the default theme.
In the default theme, the sidebar can experimentally now be made
collapsible using the new collapsiblesidebar theme option.
#129: Toctrees are now wrapped in a div tag with class
toctree-wrapper in HTML output.
The toctree callable in templates now has a maxdepth
keyword argument to control the depth of the generated tree.
The toctree callable in templates now accepts a
titles_only keyword argument.
Added htmltitle block in layout template.
In the JavaScript search, allow searching for object names including
the module name, like sys.argv.
Added new theme haiku, inspired by the Haiku OS user guide.
Added new theme nature.
Added new theme agogo, created by Andi Albrecht.
Added new theme scrolls, created by Armin Ronacher.
#193: Added a visitedlinkcolor theme option to the default
theme.
#322: Improved responsiveness of the search page by loading the
search index asynchronously.
