doc/changes/1.3.rst
page_source_suffix html context variable. This
should be introduced with :confval:!source_parsers feature. Thanks for Eric
Holscher.latex_elementssphinx.transforms.Locale always uses rst parser. Sphinx i18n
feature should support parsers that specified source_parsers.sphinx.ext.mathbase use of amsfonts may break user choice of
math fontscode-block, literalinclude and so on.:pyobject: option of literalinclude directive can't detect
indented body block when the block starts with blank or comment lines.:maxdepth: for toctrees (ref: #771):numref: if target is in orphaned doc (ref: #2244)Nonemake linkcheck is run:cpp:any:GroupedField and
TypedField):samp: with braces - font doesn't reset\py@lightbox in sphinx.sty. Thanks to
jfbu.make gettext generate broken msgid for definition lists.None. sphinxcontrib-httpdomain is one of them.numfig_format is invalidsphinx/search/non-minified-js/*.js
for source distribution on PyPI.:pyobject: option of literalinclude directive includes
following lines after class definitionsliteralinclude strips empty lines at the head and tailalabaster or sphinx_rtd_theme
can't find base theme.sphinx/search/non-minified-js/*.jssafe_getattr in the coverage builder to avoid aborting with
descriptors that have custom behavior.make text will crush if a definition list item has more than 1 classifiers
as: term : classifier1 : classifier2.'ascii' codec can't decode byte exception.:menuselection: and :guilabel:
on LaTeX builder|today| and non-ASCII date format will
raise UnicodeEncodeError.any role and sphinx.ext.intersphinx in same time.sphinx.ext.todo directive generates broken html class attribute as
'admonition-' when :confval:language is specified with non-ASCII linguistic
area like 'ru' or 'ja'. To fix this, now todo directive can use
:class: option.:param .write: breaks building.literalinclude with empty file occurs exception. Thanks to
Takayuki Hirai.source_suffix = ['.rst'] cause unfriendly error on prior version.__all__.
Thanks to Jens Hedegaard Nielsen.html_domain_indices to a list raises a type check warnings.ref, term and menusel now don't generate :durole:emphasis
nodes anymore. If you want to keep italic style, adapt your stylesheet.numref uses %s as special character to indicate position of
figure numbers instead # symbol.cpp:var as alias for cpp:member, role :cpp:var as alias
for :cpp:member, and role any for cross-reference to any C++
declaraction. #1577, #1744source_suffix config value can now be a list of multiple
suffixes.!source_parsers config value.:caption: option for :rst:dir:toctree.:name: option is provided for :rst:dir:toctree,
:rst:dir:code-block and :rst:dir:literalinclude directives.vartype field description for python domain.gettext_enables config value has been renamed to
gettext_additional_targets.http protocol.
It was used for sphinx.ext.intersphinx and some documentation.#1346: Add new default theme;
alabaster' theme.sphinx_rtd_theme' theme.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:
#1227: Add html_scaled_image_link config option to conf.py, to control
scaled image link.
__all__ is not a list of strings.python sphinx-build.py.glob option now can also contain entries for single
documents with explicit title.toctree() template function behavior that was changed at
1.3b1.:numref: does not work with capital letters in the labeldiv.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.numref_format option in captionshtml-page-context.autodoc_docstring_signature not working with signatures
in class docstrings.sphinx.ext.oldcmarkup extension.exclude_trees, exclude_dirnames and
unused_docs have been removed.sphinx.addnodes.literal_strong, has been added, for text that
should appear literally (i.e. no smart quotes) in strong font. Custom writers
will have to be adapted to handle this node.<tt> tag by <code>. User customized stylesheets
should be updated If the css contain some styles for tt> tag.
Thanks to Takeshi Komiya.templates_path is automatically added to
exclude_patterns to avoid reading autosummary rst templates in the
templates directory.Domain.resolve_any_xref
method to make the any role work properly.True to gettext_uuid to emit uuid information.
Additionally, if the python-levenshtein 3rd-party package is installed,
it will improve the calculation time.gettext_enables to enable extracting index entries.sphinx.ext.napoleon extension for NumPy and Google style docstring
support.sphinx-build -j option. Third-party extensions will need to be checked for
compatibility and may need to be adapted if they store information in the
build environment object. See env-merge-info.any role that can be used to find a cross-reference of
any type in any domain. Custom domains should implement the new
Domain.resolve_any_xref method to make this work properly.setup(), these
can be shown in the traceback log files). Version requirements for extensions
can be specified in projects using the new needs_extensions config
value.default-role
directive is now supported.numfig, numfig_secnum_depth
and numfig_format. Also numref role is available. Thanks to Takeshi
Komiya.:param: doc fields
for Python.autodoc_mock_imports, allowing to mock imports of
external modules that need not be present when autodocumenting.-D key=val1,val2.code-block and literalinclude directives
to start at an arbitrary line number, with a new lineno-start option.code-block and literalinclude
directives now can have a caption option that shows a filename before the
code in the output. Thanks to Nasimul Haque, Takeshi Komiya.html_translator_class.*.mo files from *.po files when
gettext_auto_build is True (default) and *.po is newer than
*.mo file.sphinx.ext.viewcode supports imported function/class aliases.sphinx.ext.intersphinx supports multiple target for the
inventory. Thanks to Brigitta Sipocz.env-before-read-docs event that can be connected to modify
the order of documents before they are read by the environment.option can now start with
+.code-block is recognized as a title of ref
target. Thanks to Takeshi Komiya.~sphinx.application.Sphinx.add_latex_package.
Thanks to Takeshi Komiya.gettext_enables to enable extracting 'index' to gettext
catalog output / applying translation catalog to generated documentation.literalinclude to
match that of the included file, using a new lineno-match option. Thanks
to Jeppe Pihl.--quiet will skips wizard mode. Thanks to WAKAYAMA shirou.:rtype: are now turned into links if
possible.#1438: Updated jQuery version from 1.8.3 to 1.11.1.
#1568: Fix a crash when a "centered" directive contains a reference.
Now sphinx.ext.autodoc works with python-2.5 again.
#1563: :meth:~sphinx.application.Sphinx.add_search_language raises
AssertionError for correct type of argument. Thanks to rikoman.
#1174: Fix smart quotes being applied inside roles like :rst:role:program or
makevar.
PR#235: comment db schema of websupport lacked a length of the node_id field. Thanks to solos.
#1466,PR#241: Fix failure of the cpp domain parser to parse C+11 "variadic templates" declarations. Thanks to Victor Zverovich.
#1459,PR#244: Fix default mathjax js path point to http:// that cause
mixed-content error on HTTPS server. Thanks to sbrandtb and robo9k.
PR#157: autodoc remove spurious signatures from @property decorated attributes. Thanks to David Ham.
PR#159: Add coverage targets to quickstart generated Makefile and make.bat. Thanks to Matthias Troffaes.
#1251: When specifying toctree :numbered: option and :tocdepth: metadata,
sub section number that is larger depth than :tocdepth: is shrunk.
PR#260: Encode underscore in citation labels for latex export. Thanks to Lennart Fricke.
PR#264: Fix could not resolve xref for figure node with :name: option. Thanks to Takeshi Komiya.
PR#265: Fix could not capture caption of graphviz node by xref. Thanks to Takeshi Komiya.
PR#263, #1013, #1103: Rewrite of C++ domain. Thanks to Jakob Lykke Andersen.
PR#258, #939: Add dedent option for code-block and
literalinclude. Thanks to Zafar Siddiqui.
PR#268: Fix numbering section does not work at singlehtml mode. It still ad-hoc fix because there is a issue that section IDs are conflicted. Thanks to Takeshi Komiya.
PR#273, #1536: Fix RuntimeError with numbered circular toctree. Thanks to Takeshi Komiya.
PR#274: Set its URL as a default title value if URL appears in toctree. Thanks to Takeshi Komiya.
PR#276, #1381: rfc and pep roles support custom link
text. Thanks to Takeshi Komiya.
PR#277, #1513: highlights for function pointers in argument list of
c:function. Thanks to Takeshi Komiya.
PR#278: Fix section entries were shown twice if toctree has been put under only directive. Thanks to Takeshi Komiya.
#1547: pgen2 tokenizer doesn't recognize ... literal (Ellipsis for py3).
PR#294: On LaTeX builder, wrap float environment on writing literal_block to avoid separation of caption and body. Thanks to Takeshi Komiya.
PR#295, #1520: make.bat latexpdf mechanism to cd back to the current
directory. Thanks to Peter Suter.
PR#297, #1571: Add imgpath property to all builders. It make easier to develop builder extensions. Thanks to Takeshi Komiya.
#1584: Point to master doc in HTML "top" link.
#1585: Autosummary of modules broken in Sphinx 1.2.3.
#1610: Sphinx cause AttributeError when MeCab search option is enabled and python-mecab is not installed.
#1674: Do not crash if a module's __all__ is not a list of strings.
#1673: Fix crashes with :confval:nitpick_ignore and :doc: references.
#1686: ifconfig directive doesn't care about default config values.
#1642: Fix only one search result appearing in Chrome.
doc/markup/misc.rst)