doc/changes/1.5.rst
html_compact_lists is True.\small'inputenc' key to \\usepackage[utf8x]{inputenc} leads
to failed PDF buildnav.xhtml link in content.opf
except first time buildrelease or version contain
return code\\large inserted in the title items of
:confval:latex_documents causes failed PDF build (refs #3551, #3567)literalinclude directive allows combination of :pyobject: and
:lines: options (refs: #3416)release is not escaped (refs: #3362)'releasename' in :confval:latex_elements is not working'manual' docclass has a shorter text area'pointsize' is not 10pt, Japanese 'manual' document
gets wrong PDF page dimensionsrelease breaks html search\strongIndexBuilder.load() is brokenmake commandintersphinx_mapping also allows a list as a parameterparsed-literal are wrapped like in
:rst:dir:code-block, inline math and footnotes are fully functional.None captionslatex_use_parts makes Sphinx crashmisc.highlighting_failure does not workadd_latex_package() make crashes non-LaTeX builderscode-block and
parsed-literal LaTeX output (ref #3342)" character inside parsed-literal as is (ref #3341)suppress_warnings.\DUrole)build_sphinx command crashes when missing dependency1.5a1
'locales' as a default value of locale_dirspt by TeX equivalent bp if found in width or
height attribute of an image.width or height attribute of an image is given with no unit,
use px rather than ignore it.html_sourcelink_suffix will be appended to the original filename (like
index.rst.txt).sphinx.util.copy_static_entry() is now deprecated.
Use sphinx.util.fileutil.copy_asset() instead.sphinx.util.osutil.filecopy() skips copying if the file has not been
changed (ref: #2510, #2753)nonav theme instead of default one
to improve readability.jreport and jsbook as docclass if :confval:language is
ja.sphinx-quickstart now allows a project version is emptysphinx.ext.viewcode doesn't work on epub building by default.
viewcode_enable_epub optionsphinx.ext.viewcode disabled on singlehtml builder.sphinx-quickstart by default. To disable this, use
-M optiongenindex.html, Sphinx's document template, link address to itself to
satisfy xhtml standard.epub and epub3 builders that contained links to genindex even
if epub_use_index = False.html_translator_class is now deprecated.
Use :meth:~sphinx.application.Sphinx.set_translator API instead.epub3_page_progression_direction option (use
epub3_writing_mode).latex_elements['footer'] to
latex_elements['atendofbody']1.5a2
epub3_description and epub3_contributor to
epub_description and epub_contributor.fncychapsphinx.sty latex package does not load itself "hyperref", as this
is done later in the preamble of the latex output via 'hyperref' key.tabulary.
The non-modified package is used.\sphinxBeforeFootnote allows user customization if needed.hyperfootnotes of package hyperref
be left unchanged to its default (i.e. true) (refs: #3022)1.5 final
themes/basic/defindex.html is now deprecatedwhen-deprecation-warnings-are-displayed.SOURCELINK_SUFFIX is addedThese features are removed in Sphinx 1.6:
sphinx.addnodes.termsepsphinx.util.pycompat:
zip_longest, product, all, any, next, open,
class_types, base_exception, relpath, StringIO, BytesIO.
Please use the standard library version instead;If any deprecation warning like RemovedInSphinxXXXWarning are displayed,
please refer :ref:when-deprecation-warnings-are-displayed.
1.5a1
#2951: Add --implicit-namespaces PEP-0420 support to apidoc.
Add :caption: option for sphinx.ext.inheritance_diagram.
#2471: Add config variable for default doctest flags.
Convert linkcheck builder to requests for better encoding handling
#2463, #2516: Add keywords of "meta" directive to search index
:maxdepth: option of toctree affects secnumdepth (ref: #2547)
#2575: Now sphinx.ext.graphviz allows :align: option
Show warnings if unknown key is specified to latex_elements
Show warnings if no domains match with primary_domain (ref: #2001)
C++, show warnings when the kind of role is misleading for the kind
of target it refers to (e.g., using the class role for a function).
latex, writer abstracts more of text styling into customizable macros, e.g.
the visit_emphasis will output \sphinxstyleemphasis rather than
\emph (which may be in use elsewhere or in an added LaTeX package). See
list at end of sphinx.sty (ref: #2686)
latex, public names for environments and parameters used by note, warning,
and other admonition types, allowing full customizability from the
'preamble' key or an input file (ref: feature request #2674, #2685)
latex, better computes column widths of some tables (as a result, there will be slight changes as tables now correctly fill the line width; ref: #2708)
latex, sphinxVerbatim environment is more easily customizable (ref: #2704). In addition to already existing VerbatimColor and VerbatimBorderColor:
\sphinxverbatimsep and \sphinxverbatimborder,\ifsphinxverbatimwithframe and \ifsphinxverbatimwrapslines.latex, captions for literal blocks inside tables are handled, and long code lines wrapped to fit table cell (ref: #2704)
#2597: Show warning messages as darkred
latex, allow image dimensions using px unit (default is 96px=1in)
Show warnings if invalid dimension units found
#2650: Add --pdb option to setup.py command
latex, make the use of \small for code listings customizable (ref #2721)
#2663: Add --warning-is-error option to setup.py command
Show warnings if deprecated latex options are used
Add sphinx.config.ENUM to check the config values is in candidates
math: Add hyperlink marker to each equations in HTML output
Add new theme nonav that doesn't include any navigation links.
This is for any help generator like qthelp.
#2680: sphinx.ext.todo now emits warnings if todo_emit_warnings enabled.
Also, it emits an additional event named todo-defined to handle the TODO
entries in 3rd party extensions.
Python domain signature parser now uses the xref mixin for 'exceptions', allowing exception classes to be autolinked.
#2513: Add latex_engine to switch the LaTeX engine by conf.py
#2682: C++, basic support for attributes (C++11 style and GNU style). The new configuration variables 'cpp_id_attributes' and 'cpp_paren_attributes' can be used to introduce custom attributes.
#1958: C++, add configuration variable 'cpp_index_common_prefix' for removing prefixes from the index text of C++ objects.
C++, added concept directive. Thanks to mickk-on-cpp.
C++, added support for template introduction syntax. Thanks to mickk-on-cpp.
#2725: latex builder: allow to use user-defined template file (experimental)
apidoc now avoids invalidating cached files by not writing to files whose content doesn't change. This can lead to significant performance wins if apidoc is run frequently.
#2851: sphinx.ext.math emits missing-reference event if equation not found
#1210: eqref role now supports cross reference
#2892: Added -a (--append-syspath) option to sphinx-apidoc
#1604: epub3 builder: Obey font-related CSS when viewing in iBooks.
#646: option directive support '.' character as a part of options
Add document about kindlegen and fix document structure for it.
#2474: Add intersphinx_timeout option to sphinx.ext.intersphinx
#2926: EPUB3 builder supports vertical mode (epub3_writing_mode option)
#2695: build_sphinx subcommand for setuptools handles exceptions as same
as sphinx-build does
#326: numref role can also refer sections
#2916: numref role can also refer caption as an its linktext
1.5a2
linkcheck builder ignores self-signed certificate URL'geometry' key to latex_elements whose default uses
LaTeX style file geometry.sty to set page layout:reversed: option to toctree directive-t and -d option to sphinx-quickstart to support templating
generated Sphinx project.{path} and {basename} to the format of
figure_language_filename'hyperref' key in the latex_elements dictionary (ref #3030)1.5b1
'maxlistdepth' key to work around LaTeX list limitations--extensions to sphinx-quickstart to support enable arbitrary
extensions from command line (ref: #2904)'sphinxsetup' for key=value styling of Sphinx LaTeXlinkcheck_anchors_ignore~ (fixed #3019)inlineliteralwraps option to control if inline literal
word-wraps in latex1.5 final
tls_verify and :confval:tls_cacerts to support
self-signed HTTPS servers in linkcheck and intersphinxmisc.highlighting_failure1.5a1
sphinx.ext.autodoc crashes if target code imports * from mock modules
by autodoc_mock_imports.Sphinx.add_node does not add handlers the translator installed by
html_translator_classonly
directives1.5a2
latex_elements.papersize to specify papersize of LaTeX in Makefileoption directive generates invalid HTML anchorshtml_split_index enabled\pysigline in LaTeX style file (ref #3023)sphinx.ext.math* raises TypeError if labels are duplicatedtocloft1.5b1
\hypersetup for
Japanese documents since PR#3030)scale before textwidth fit (ref #2865,
#3059)< > - gobbled a space1.5 final
'babel' key is set to empty string, LaTeX output contains
one \addto\captions...'babel' key setting is not obeyed anymorehtml_sourcelink_suffix fails with IE and Operaunittest.mock exists.