doc/changes/1.2.rst
sphinx-apidoc command now has a --version option to show
version information and exitsetup in a conf.py, now sphinx-build emits
a user-friendly error message.sys.exit(). Now Sphinx avoids SystemExit
exception and emits warnings without unexpected termination.[]. Thanks to Geert Jansen.make text generates wrong table when it has empty table cells.python setup.py build_sphinx -b doctest return zero even if doctest
failed.html_logo file, check
the full relative path and not the basename.__init__ methods without docstring.option are now again allowed to
not start with a dash or slash, and referencing them will work correctly.item argument usage.documentation about building extensions <dev-extensions>.{% extends "!autosummary/class.rst" %} cause infinite recursive function
call. This was caused by PR#181.autoclass_content="both" uses useless
object.__init__ docstring when class does not have __init__.
This was caused by a change for #1138.html_logo file does not exist.__bases__.__doc__ is not a string.option value is malformed (contains
spaces but no option name).pngmath_latex_preamble changes.objects.inv to be referenced via
:mod:~sphinx.ext.intersphinx.:noindex: set.figure
directive as documented by docutils.option
does not match the required format.nitpick_ignore; now you don't have to
remove the store environment for changes to have effect.math directive more consistent and
avoid producing empty environments in LaTeX output.sphinx.ext.viewcode extension.sphinx-apidoc.sphinx.ext.inheritance_diagram when
documenting classes that can't be pickled.font-face resources from epub theme.exclude_patterns behavior with subdirectories in the
html_static_path.<ul> tags in the HTML writer, which is not
valid HTML.doc/tutorial.rst)sphinx.version_info tuple for programmatic checking of the Sphinx
version.sphinx.ext.refcounting extension -- it is very specific to
CPython and has no place in the main distribution.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.
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.apidoc can now write each module to a standalone page instead of
combining all modules in a package on one page.html_extra_path config value allows to specify directories
with files that should be copied directly to the HTML output directory.annotation option, so that the default display of the data/attribute
value can be overridden.imported-members option to
include members imported from different modules.sphinx.util.compat.directive_dwim() and
sphinx.roles.xfileref_role() which were deprecated since version 1.0.latex_additional_files now override TeX
files included by Sphinx, such as sphinx.sty.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.seealso directive now generates admonition nodes instead
of the custom seealso node.Markup
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).HTML builder
Texinfo builder
desc_annotation nodes are now rendered.strong and emphasis nodes are now formatted like
literal\s. 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.system_message and problematic nodes are now formatted in a similar
fashion as done by the text builder.@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).@finalout command has been added for better TeX output.transition nodes are now formatted using underscores ("_") instead of
asterisks ("*").paragraphindent has been changed from 2 to 0
meaning that paragraphs are no longer indented by default.texinfo_no_detailmenu has been
added for controlling whether a @detailmenu is added in the "Top"
node's menu.LaTeX builder:
'transition' item in latex_elements for
customizing how transitions are displayed. Thanks to Jeff Klukas.'cmappkg' item in latex_elements can be used to control this.
Thanks to Dmitry Shachnev.'fontpkg' item in latex_elements now defaults to ''
when the :confval:language uses the Cyrillic script. Suggested by Dmitry
Shachnev.latex_documents, texinfo_documents, and
man_pages configuration values will be set to default values based
on the :confval:master_doc if not explicitly set in :file:conf.py.
Previously, if these values were not set, no output would be generated 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 make gettext.
PR#61,#703: Add support for non-ASCII filename handling.
Other builders:
~sphinx.builders.xml.XMLBuilder and
:class:~sphinx.builders.xml.PseudoXMLBuilder.#anchor\ s for existence.epub_use_index configuration value. If
provided, it will be used instead of html_use_index for epub
builder.epub_tocscope configuration value. The setting
controls the generation of the epub toc. The user can now also include
hidden toc entries.epub_show_urls configuration value.Extensions:
special_members flag to autodoc now behaves like members.sphinx.ext.linkcode extension.Command-line interfaces:
--follow-links option to sphinx-apidoc.-T for printing the full
traceback after an unhandled exception.--help and --version options.-v which can be repeated for
greater effect. A single occurrence 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:
Optimizations:
sphinx-build -j option.doc/devguide.rst)
which outlines the basic development process of the Sphinx project.doc/install.rst).<p> tag). Fix
versionmodified is not translatable. Thanks to Nozomu Kaneko.literalinclude.html_search_language is 'ja'. Thanks to Tomo Saito.input() returns values with an extra '\r' on Python 3.2.0 +
Windows. Thanks to Régis Décamps.environment.pickle after a failed build.Image without PIL
namespace. Thanks to Marc Schlaich.