Changelog¶
Release 3.5.0 (in development)¶
Dependencies¶
Incompatible changes¶
Deprecated¶
sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()
sphinx.ext.autodoc.directive.DocumenterBridge.reporter
sphinx.ext.autodoc.importer.get_module_members()
Features added¶
#8022: autodoc: autodata and autoattribute directives does not show right-hand value of the variable if docstring contains
:meta hide-value:
in info-field-list#8619: html: kbd role generates customizable HTML tags for compound keys
#8634: html: Allow to change the order of JS/CSS via
priority
parameter forSphinx.add_js_file()
andSphinx.add_css_file()
#6241: html: Allow to add JS/CSS files to the specific page when an extension calls
app.add_js_file()
orapp.add_css_file()
on :event:`html-page-context` event#8649: imgconverter: Skip availability check if builder supports the image type
#6241: mathjax: Include mathjax.js only on the document using equations
#8651: std domain: cross-reference for a rubric having inline item is broken
#8132: Add :confval:`project_copyright` as an alias of :confval:`copyright`
#207: Now :confval:`highlight_language` supports multiple languages
#2030:
code-block
andliteralinclude
supports automatic dedent via no-argument:dedent:
option
Bugs fixed¶
#741: autodoc: inherited-members doesn’t work for instance attributes on super class
#8592: autodoc:
:meta public:
does not effect to variables#8594: autodoc: empty __all__ attribute is ignored
#8315: autodoc: Failed to resolve struct.Struct type annotation
#8652: autodoc: All variable comments in the module are ignored if the module contains invalid type comments
#8306: autosummary: mocked modules are documented as empty page when using :recursive: option
#8618: html: kbd role produces incorrect HTML when compound-key separators (-, + or ^) are used as keystrokes
#8629: html: A type warning for html_use_opensearch is shown twice
#8665: html theme: Could not override globaltoc_maxdepth in theme.conf
#8094: texinfo: image files on the different directory with document are not copied
#8671: :confval:`highlight_options` is not working
#8341: C, fix intersphinx lookup types for names in declarations.
C, C++: in general fix intersphinx and role lookup types.
#8683: :confval:`html_last_updated_fmt` does not support UTC offset (%z)
#8683: :confval:`html_last_updated_fmt` generates wrong time zone for %Z
Testing¶
Release 3.4.4 (in development)¶
Dependencies¶
Incompatible changes¶
Deprecated¶
Features added¶
Bugs fixed¶
Testing¶
Release 3.4.3 (released Jan 08, 2021)¶
Bugs fixed¶
#8655: autodoc: Failed to generate document if target module contains an object that raises an exception on
hasattr()
Release 3.4.2 (released Jan 04, 2021)¶
Bugs fixed¶
#8164: autodoc: Classes that inherit mocked class are not documented
#8602: autodoc: The
autodoc-process-docstring
event is emitted to the non-datadescriptors unexpectedly#8616: autodoc: AttributeError is raised on non-class object is passed to autoclass directive
Release 3.4.1 (released Dec 25, 2020)¶
Bugs fixed¶
#8559: autodoc: AttributeError is raised when using forward-reference type annotations
#8568: autodoc: TypeError is raised on checking slots attribute
#8567: autodoc: Instance attributes are incorrectly added to Parent class
#8566: autodoc: The
autodoc-process-docstring
event is emitted to the alias classes unexpectedly#8583: autodoc: Unnecessary object comparision via
__eq__
method#8565: linkcheck: Fix PriorityQueue crash when link tuples are not comparable
Release 3.4.0 (released Dec 20, 2020)¶
Incompatible changes¶
#8105: autodoc: the signature of class constructor will be shown for decorated classes, not a signature of decorator
Deprecated¶
The
follow_wrapped
argument ofsphinx.util.inspect.signature()
The
no_docstring
argument ofsphinx.ext.autodoc.Documenter.add_content()
sphinx.ext.autodoc.Documenter.get_object_members()
sphinx.ext.autodoc.DataDeclarationDocumenter
sphinx.ext.autodoc.GenericAliasDocumenter
sphinx.ext.autodoc.InstanceAttributeDocumenter
sphinx.ext.autodoc.SlotsAttributeDocumenter
sphinx.ext.autodoc.TypeVarDocumenter
sphinx.ext.autodoc.importer._getannotations()
sphinx.ext.autodoc.importer._getmro()
sphinx.pycode.ModuleAnalyzer.parse()
sphinx.util.osutil.movefile()
sphinx.util.requests.is_ssl_error()
Features added¶
#8119: autodoc: Allow to determine whether a member not included in
__all__
attribute of the module should be documented or not via :event:`autodoc-skip-member` event#8219: autodoc: Parameters for generic class are not shown when super class is a generic class and show-inheritance option is given (in Python 3.7 or above)
autodoc: Add
Documenter.config
as a shortcut to access the config objectautodoc: Add Optional[t] to annotation of function and method if a default value equal to None is set.
#8209: autodoc: Add
:no-value:
option toautoattribute
andautodata
directive to suppress the default value of the variable#8460: autodoc: Support custom types defined by typing.NewType
#8285: napoleon: Add :confval:`napoleon_attr_annotations` to merge type hints on source code automatically if any type is specified in docstring
#8236: napoleon: Support numpydoc’s “Receives” section
#6914: Add a new event :event:`warn-missing-reference` to custom warning messages when failed to resolve a cross-reference
#6914: Emit a detailed warning when failed to resolve a
:ref:
reference#6629: linkcheck: The builder now handles rate limits. See :confval:`linkcheck_retry_on_rate_limit` for details.
Bugs fixed¶
#7613: autodoc: autodoc does not respect __signature__ of the class
#4606: autodoc: the location of the warning is incorrect for inherited method
#8105: autodoc: the signature of class constructor is incorrect if the class is decorated
#8434: autodoc: :confval:`autodoc_type_aliases` does not effect to variables and attributes
#8443: autodoc: autodata directive can’t create document for PEP-526 based type annotated variables
#8443: autodoc: autoattribute directive can’t create document for PEP-526 based uninitalized variables
#8480: autodoc: autoattribute could not create document for __slots__ attributes
#8503: autodoc: autoattribute could not create document for a GenericAlias as class attributes correctly
#8534: autodoc: autoattribute could not create document for a commented attribute in alias class
#8452: autodoc: autodoc_type_aliases doesn’t work when autodoc_typehints is set to “description”
#8541: autodoc: autodoc_type_aliases doesn’t work for the type annotation to instance attributes
#8460: autodoc: autodata and autoattribute directives do not display type information of TypeVars
#8493: autodoc: references to builtins not working in class aliases
#8522: autodoc:
__bool__
method could be called#8067: autodoc: A typehint for the instance variable having type_comment on super class is not displayed
#8545: autodoc: a __slots__ attribute is not documented even having docstring
#741: autodoc: inherited-members doesn’t work for instance attributes on super class
#8477: autosummary: non utf-8 reST files are generated when template contains multibyte characters
#8501: autosummary: summary extraction splits text after “el at.” unexpectedly
#8524: html: Wrong url_root has been generated on a document named “index”
#8419: html search: Do not load
language_data.js
in non-search pages#8549: i18n:
-D gettext_compact=0
is no longer working#8454: graphviz: The layout option for graph and digraph directives don’t work
#8131: linkcheck: Use GET when HEAD requests cause Too Many Redirects, to accommodate infinite redirect loops on HEAD
#8437: Makefile:
make clean
with empty BUILDDIR is dangerous#8365: py domain:
:type:
and:rtype:
gives false ambiguous class lookup warnings#8352: std domain: Failed to parse an option that starts with bracket
#8519: LaTeX: Prevent page brake in the middle of a seealso
#8520: C, fix copying of AliasNode.
Release 3.3.1 (released Nov 12, 2020)¶
Bugs fixed¶
#8372: autodoc: autoclass directive became slower than Sphinx-3.2
#7727: autosummary: raise PycodeError when documenting python package without __init__.py
#8350: autosummary: autosummary_mock_imports causes slow down builds
#8364: C, properly initialize attributes in empty symbols.
#8399: i18n: Put system locale path after the paths specified by configuration
Release 3.3.0 (released Nov 02, 2020)¶
Deprecated¶
sphinx.builders.latex.LaTeXBuilder.usepackages
sphinx.builders.latex.LaTeXBuilder.usepackages_afger_hyperref
sphinx.ext.autodoc.SingledispatchFunctionDocumenter
sphinx.ext.autodoc.SingledispatchMethodDocumenter
Features added¶
#8100: html: Show a better error message for failures on copying html_static_files
#8141: C: added a
maxdepth
option toc:alias
to insert nested declarations.#8081: LaTeX: Allow to add LaTeX package via
app.add_latex_package()
until just before writing .tex file#7996: manpage: Add :confval:`man_make_section_directory` to make a section directory on build man page
#8289: epub: Allow to suppress “duplicated ToC entry found” warnings from epub builder using :confval:`suppress_warnings`.
#8298: sphinx-quickstart: Add
sphinx-quickstart --no-sep
option#8304: sphinx.testing: Register public markers in sphinx.testing.fixtures
#8051: napoleon: use the obj role for all See Also items
#8050: napoleon: Apply :confval:`napoleon_preprocess_types` to every field
C and C++, show line numbers for previous declarations when duplicates are detected.
#8183: Remove substitution_reference nodes from doctree only on LaTeX builds
Bugs fixed¶
#8085: i18n: Add support for having single text domain
#6640: i18n: Failed to override system message translation
#8143: autodoc: AttributeError is raised when False value is passed to autodoc_default_options
#8103: autodoc: functools.cached_property is not considered as a property
#8190: autodoc: parsing error is raised if some extension replaces docstring by string not ending with blank lines
#8142: autodoc: Wrong constructor signature for the class derived from typing.Generic
#8157: autodoc: TypeError is raised when annotation has invalid __args__
#7964: autodoc: Tuple in default value is wrongly rendered
#8200: autodoc: type aliases break type formatting of autoattribute
#7786: autodoc: can’t detect overloaded methods defined in other file
#8294: autodoc: single-string __slots__ is not handled correctly
#7785: autodoc: autodoc_typehints=’none’ does not effect to overloaded functions
#8192: napoleon: description is disappeared when it contains inline literals
#8142: napoleon: Potential of regex denial of service in google style docs
#8169: LaTeX: pxjahyper loaded even when latex_engine is not platex
#8215: LaTeX: ‘oneside’ classoption causes build warning
#8175: intersphinx: Potential of regex denial of service by broken inventory
#8277: sphinx-build: missing and redundant spacing (and etc) for console output on building
#7973: imgconverter: Check availability of imagemagick many times
#8255: py domain: number in default argument value is changed from hexadecimal to decimal
#8316: html: Prevent arrow keys changing page when button elements are focused
#8343: html search: Fix unnecessary load of images when parsing the document
#8254: html theme: Line numbers misalign with code lines
#8093: The highlight warning has wrong location in some builders (LaTeX, singlehtml and so on)
#8215: Eliminate Fancyhdr build warnings for oneside documents
#8239: Failed to refer a token in productionlist if it is indented
#8268: linkcheck: Report HTTP errors when
linkcheck_anchors
isTrue
#8245: linkcheck: take source directory into account for local files
#8321: linkcheck:
tel:
schema hyperlinks are detected as errors#8323: linkcheck: An exit status is incorrect when links having unsupported schema found
#8188: C, add missing items to internal object types dictionary, e.g., preventing intersphinx from resolving them.
C, fix anon objects in intersphinx.
#8270, C++, properly reject functions as duplicate declarations if a non-function declaration of the same name already exists.
C, fix references to function parameters. Link to the function instead of a non-existing anchor.
#6914: figure numbers are unexpectedly assigned to uncaptioned items
#8320: make “inline” line numbers un-selectable
Testing¶
#8257: Support parallel build in sphinx.testing
Release 3.2.1 (released Aug 14, 2020)¶
Features added¶
#8095: napoleon: Add :confval:`napoleon_preprocess_types` to enable the type preprocessor for numpy style docstrings
#8114: C and C++, parse function attributes after parameters and qualifiers.
Bugs fixed¶
#8074: napoleon: Crashes during processing C-ext module
#8088: napoleon: “Inline literal start-string without end-string” warning in Numpy style Parameters section
#8084: autodoc: KeyError is raised on documenting an attribute of the broken class
#8091: autodoc: AttributeError is raised on documenting an attribute on Python 3.5.2
#8099: autodoc: NameError is raised when target code uses
TYPE_CHECKING
C++, fix parsing of template template paramters, broken by the fix of #7944
Release 3.2.0 (released Aug 08, 2020)¶
Deprecated¶
sphinx.ext.autodoc.members_set_option()
sphinx.ext.autodoc.merge_special_members_option()
sphinx.writers.texinfo.TexinfoWriter.desc
C, parsing of pre-v3 style type directives and roles, along with the options :confval:`c_allow_pre_v3` and :confval:`c_warn_on_allowed_pre_v3`.
Features added¶
#2076: autodoc: Allow overriding of exclude-members in skip-member function
#8034: autodoc:
:private-member:
can take an explicit list of member names to be documented#2024: autosummary: Add :confval:`autosummary_filename_map` to avoid conflict of filenames between two object with different case
#8011: autosummary: Support instance attributes as a target of autosummary directive
#7849: html: Add :confval:`html_codeblock_linenos_style` to change the style of line numbers for code-blocks
#7853: C and C++, support parameterized GNU style attributes.
#7888: napoleon: Add aliases Warn and Raise.
#7690: napoleon: parse type strings and make them hyperlinks as possible. The conversion rule can be updated via :confval:`napoleon_type_aliases`
#8049: napoleon: Create a hyperlink for each the type of parameter when :confval:`napoleon_use_params` is False
C, added
c:alias
directive for inserting copies of existing declarations.#7745: html: inventory is broken if the docname contains a space
#7991: html search: Allow searching for numbers
#7902: html theme: Add a new option :confval:`globaltoc_maxdepth` to control the behavior of globaltoc in sidebar
#7840: i18n: Optimize the dependencies check on bootstrap
#7768: i18n: :confval:`figure_language_filename` supports
docpath
token#5208: linkcheck: Support checks for local links
#5090: setuptools: Link verbosity to distutils’ -v and -q option
#6698: doctest: Add
:trim-doctest-flags:
and:no-trim-doctest-flags:
options to doctest, testcode and testoutput directives#7052: add
:noindexentry:
to the Python, C, C++, and Javascript domains. Update the documentation to better reflect the relationship between this option and the:noindex:
option.#7899: C, add possibility of parsing of some pre-v3 style type directives and roles and try to convert them to equivalent v3 directives/roles. Set the new option :confval:`c_allow_pre_v3` to
True
to enable this. The warnings printed from this functionality can be suppressed by setting :confval:`c_warn_on_allowed_pre_v3`` toTrue
. The functionality is immediately deprecated.#7999: C, add support for named variadic macro arguments.
#8071: Allow to suppress “self referenced toctrees” warning
Bugs fixed¶
#7886: autodoc: TypeError is raised on mocking generic-typed classes
#7935: autodoc: function signature is not shown when the function has a parameter having
inspect._empty
as its default value#7901: autodoc: type annotations for overloaded functions are not resolved
#904: autodoc: An instance attribute cause a crash of autofunction directive
#1362: autodoc:
private-members
option does not work for class attributes#7983: autodoc: Generator type annotation is wrongly rendered in py36
#8030: autodoc: An uninitialized annotated instance variable is not documented when
:inherited-members:
option given#8032: autodoc: A type hint for the instance variable defined at parent class is not shown in the document of the derived class
#8041: autodoc: An annotated instance variable on super class is not documented when derived class has other annotated instance variables
#7839: autosummary: cannot handle umlauts in function names
#7865: autosummary: Failed to extract summary line when abbreviations found
#7866: autosummary: Failed to extract correct summary line when docstring contains a hyperlink target
#7469: autosummary: “Module attributes” header is not translatable
#7940: apidoc: An extra newline is generated at the end of the rst file if a module has submodules
#4258: napoleon: decorated special methods are not shown
#7799: napoleon: parameters are not escaped for combined params in numpydoc
#7780: napoleon: multiple paramaters declaration in numpydoc was wrongly recognized when napoleon_use_params=True
#7715: LaTeX:
numfig_secnum_depth > 1
leads to wrong figure links#7846: html theme: XML-invalid files were generated
#7894: gettext: Wrong source info is shown when using rst_epilog
#7691: linkcheck: HEAD requests are not used for checking
#4888: i18n: Failed to add an explicit title to
:ref:
role on translation#7928: py domain: failed to resolve a type annotation for the attribute
#8008: py domain: failed to parse a type annotation containing ellipsis
#7994: std domain: option directive does not generate old node_id compatible with 2.x or older
#7968: i18n: The content of
math
directive is interpreted as reST on translation#7768: i18n: The
root
element for :confval:`figure_language_filename` is not a path that user specifies in the document#7993: texinfo: TypeError is raised for nested object descriptions
#7993: texinfo: a warning not supporting desc_signature_line node is shown
#7869:
abbr
role without an explanation will show the explanation from the previous abbr role#8048: graphviz: graphviz.css was copied on building non-HTML document
C and C++, removed
noindex
directive option as it did nothing.#7619: Duplicated node IDs are generated if node has multiple IDs
#2050: Symbols sections are appeared twice in the index page
#8017: Fix circular import in sphinx.addnodes
#7986: CSS: make “highlight” selector more robust
#7944: C++, parse non-type template parameters starting with a dependent qualified name.
C, don’t deepcopy the entire symbol table and make a mess every time an enumerator is handled.
Release 3.1.2 (released Jul 05, 2020)¶
Incompatible changes¶
#7650: autodoc: the signature of base function will be shown for decorated functions, not a signature of decorator
Bugs fixed¶
#7844: autodoc: Failed to detect module when relative module name given
#7856: autodoc: AttributeError is raised when non-class object is given to the autoclass directive
#7850: autodoc: KeyError is raised for invalid mark up when autodoc_typehints is ‘description’
#7812: autodoc: crashed if the target name matches to both an attribute and module that are same name
#7650: autodoc: function signature becomes
(*args, **kwargs)
if the function is decorated by generic decorator#7812: autosummary: generates broken stub files if the target code contains an attribute and module that are same name
#7806: viewcode: Failed to resolve viewcode references on 3rd party builders
#7838: html theme: List items have extra vertical space
#7878: html theme: Undesired interaction between “overflow” and “float”
Release 3.1.1 (released Jun 14, 2020)¶
Incompatible changes¶
#7808: napoleon: a type for attribute are represented as typed field
Features added¶
#7807: autodoc: Show detailed warning when type_comment is mismatched with its signature
Bugs fixed¶
#7808: autodoc: Warnings raised on variable and attribute type annotations
#7802: autodoc: EOFError is raised on parallel build
#7821: autodoc: TypeError is raised for overloaded C-ext function
#7805: autodoc: an object which descriptors returns is unexpectedly documented
#7807: autodoc: wrong signature is shown for the function using contextmanager
#7812: autosummary: generates broken stub files if the target code contains an attribute and module that are same name
#7808: napoleon: Warnings raised on variable and attribute type annotations
#7811: sphinx.util.inspect causes circular import problem
Release 3.1.0 (released Jun 08, 2020)¶
Dependencies¶
#7746: mathjax: Update to 2.7.5
Incompatible changes¶
#7477: imgconverter: Invoke “magick convert” command by default on Windows
Deprecated¶
The first argument for sphinx.ext.autosummary.generate.AutosummaryRenderer has been changed to Sphinx object
sphinx.ext.autosummary.generate.AutosummaryRenderer
takes an object type as an argumentThe
ignore
argument ofsphinx.ext.autodoc.Documenter.get_doc()
The
template_dir
argument ofsphinx.ext.autosummary.generate. AutosummaryRenderer
The
module
argument ofsphinx.ext.autosummary.generate. find_autosummary_in_docstring()
The
builder
argument ofsphinx.ext.autosummary.generate. generate_autosummary_docs()
The
template_dir
argument ofsphinx.ext.autosummary.generate. generate_autosummary_docs()
The
ignore
argument ofsphinx.util.docstring.prepare_docstring()
sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()
sphinx.util.rpartition()
Features added¶
LaTeX: Make the
toplevel_sectioning
setting optional in LaTeX themeLaTeX: Allow to override papersize and pointsize from LaTeX themes
LaTeX: Add :confval:`latex_theme_options` to override theme options
#7410: Allow to suppress “circular toctree references detected” warnings using :confval:`suppress_warnings`
C, added scope control directives,
c:namespace
,c:namespace-push
, andc:namespace-pop
.#2044: autodoc: Suppress default value for instance attributes
#7473: autodoc: consider a member public if docstring contains
:meta public:
in info-field-list#7487: autodoc: Allow to generate docs for singledispatch functions by py:autofunction
#7143: autodoc: Support final classes and methods
#7384: autodoc: Support signatures defined by
__new__()
, metaclasses and builtin base classes#2106: autodoc: Support multiple signatures on docstring
#4422: autodoc: Support GenericAlias in Python 3.7 or above
#3610: autodoc: Support overloaded functions
#7722: autodoc: Support TypeVar
#7466: autosummary: headings in generated documents are not translated
#7490: autosummary: Add
:caption:
option to autosummary directive to set a caption to the toctree#7469: autosummary: Support module attributes
#248, #6040: autosummary: Add
:recursive:
option to autosummary directive to generate stub files recursively#4030: autosummary: Add :confval:`autosummary_context` to add template variables for custom templates
#7530: html: Support nested <kbd> elements
#7481: html theme: Add right margin to footnote/citation labels
#7482, #7717: html theme: CSS spacing for code blocks with captions and line numbers
#7443: html theme: Add new options :confval:`globaltoc_collapse` and :confval:`globaltoc_includehidden` to control the behavior of globaltoc in sidebar
#7484: html theme: Avoid clashes between sidebar and other blocks
#7476: html theme: Relbar breadcrumb should contain current page
#7506: html theme: A canonical URL is not escaped
#7533: html theme: Avoid whitespace at the beginning of genindex.html
#7541: html theme: Add a “clearer” at the end of the “body”
#7542: html theme: Make admonition/topic/sidebar scrollable
#7543: html theme: Add top and bottom margins to tables
#7695: html theme: Add viewport meta tag for basic theme
#7721: html theme: classic: default codetextcolor/codebgcolor doesn’t override Pygments
C and C++: allow semicolon in the end of declarations.
C++, parse parameterized noexcept specifiers.
#7294: C++, parse expressions with user-defined literals.
C++, parse trailing return types.
#7143: py domain: Add
:final:
option topy:class:
,py:exception:
andpy:method:
directives#7596: py domain: Change a type annotation for variables to a hyperlink
#7770: std domain:
option
directive support arguments in the form offoo[=bar]
#7582: napoleon: a type for attribute are represented like type annotation
#7734: napoleon: overescaped trailing underscore on attribute
#7247: linkcheck: Add :confval:`linkcheck_request_headers` to send custom HTTP headers for specific host
#7792: setuptools: Support
--verbosity
option#7683: Add
allowed_exceptions
parameter toSphinx.emit()
to allow handlers to raise specified exceptions#7295: C++, parse (trailing) requires clauses.
Bugs fixed¶
#6703: autodoc: incremental build does not work for imported objects
#7564: autodoc: annotations not to be shown for descriptors
#6588: autodoc: Decorated inherited method has no documentation
#7469: autodoc: The change of autodoc-process-docstring for variables is cached unexpectedly
#7559: autodoc: misdetects a sync function is async
#6857: autodoc: failed to detect a classmethod on Enum class
#7562: autodoc: a typehint contains spaces is wrongly rendered under autodoc_typehints=’description’ mode
#7551: autodoc: failed to import nested class
#7362: autodoc: does not render correct signatures for built-in functions
#7654: autodoc:
Optional[Union[foo, bar]]
is presented asUnion[foo, bar, None]
#7629: autodoc: autofunction emits an unfriendly warning if an invalid object specified
#7650: autodoc: undecorated signature is shown for decorated functions
#7676: autodoc: typo in the default value of autodoc_member_order
#7676: autodoc: wrong value for :member-order: option is ignored silently
#7676: autodoc: member-order=”bysource” does not work for C module
#3673: autodoc: member-order=”bysource” does not work for a module having __all__
#7668: autodoc: wrong retann value is passed to a handler of autodoc-proccess-signature
#7711: autodoc: fails with ValueError when processing numpy objects
#7791: autodoc: TypeError is raised on documenting singledispatch function
#7551: autosummary: a nested class is indexed as non-nested class
#7661: autosummary: autosummary directive emits warnings twices if failed to import the target module
#7685: autosummary: The template variable “members” contains imported members even if :confval:`autossummary_imported_members` is False
#7671: autosummary: The location of import failure warning is missing
#7535: sphinx-autogen: crashes when custom template uses inheritance
#7536: sphinx-autogen: crashes when template uses i18n feature
#7781: sphinx-build: Wrong error message when outdir is not directory
#7653: sphinx-quickstart: Fix multiple directory creation for nested relpath
#2785: html: Bad alignment of equation links
#7718: html theme: some themes does not respect background color of Pygments style (agogo, haiku, nature, pyramid, scrolls, sphinxdoc and traditional)
#7544: html theme: inconsistent padding in admonitions
#7581: napoleon: bad parsing of inline code in attribute docstrings
#7628: imgconverter: runs imagemagick once unnecessary for builders not supporting images
#7610: incorrectly renders consecutive backslashes for docutils-0.16
#7646: handle errors on event handlers
#4187: LaTeX: EN DASH disappears from PDF bookmarks in Japanese documents
#7701: LaTeX: Anonymous indirect hyperlink target causes duplicated labels
#7723: LaTeX: pdflatex crashed when URL contains a single quote
#7756: py domain: The default value for positional only argument is not shown
#7760: coverage: Add :confval:`coverage_show_missing_items` to show coverage result to console
C++, fix rendering and xrefs in nested names explicitly starting in global scope, e.g.,
::A::B
.C, fix rendering and xrefs in nested names explicitly starting in global scope, e.g.,
.A.B
.#7763: C and C++, don’t crash during display stringification of unary expressions and fold expressions.
Release 3.0.4 (released May 27, 2020)¶
Bugs fixed¶
#7567: autodoc: parametrized types are shown twice for generic types
#7637: autodoc: system defined TypeVars are shown in Python 3.9
#7696: html: Updated jQuery version from 3.4.1 to 3.5.1 for security reasons
#7611: md5 fails when OpenSSL FIPS is enabled
#7626: release package does not contain
CODE_OF_CONDUCT
Release 3.0.3 (released Apr 26, 2020)¶
Features added¶
C, parse array declarators with static, qualifiers, and VLA specification.
Bugs fixed¶
#7516: autodoc: crashes if target object raises an error on accessing its attributes
Release 3.0.2 (released Apr 19, 2020)¶
Features added¶
C, parse attributes and add :confval:`c_id_attributes` and :confval:`c_paren_attributes` to support user-defined attributes.
Bugs fixed¶
#7461: py domain: fails with IndexError for empty tuple in type annotation
#7510: py domain: keyword-only arguments are documented as having a default of None
#7418: std domain:
term
role could not match case-insensitively#7461: autodoc: empty tuple in type annotation is not shown correctly
#7479: autodoc: Sphinx builds has been slower since 3.0.0 on mocking
C++, fix spacing issue in east-const declarations.
#7414: LaTeX: Xindy language options were incorrect
sphinx crashes with ImportError on python3.5.1
Release 3.0.1 (released Apr 11, 2020)¶
Incompatible changes¶
#7418: std domain:
term
role becomes case sensitive
Bugs fixed¶
#7428: py domain: a reference to class
None
emits a nitpicky warning#7445: py domain: a return annotation
None
in the function signature is not converted to a hyperlink when using intersphinx#7418: std domain: duplication warning for glossary terms is case insensitive
#7438: C++, fix merging overloaded functions in parallel builds.
#7422: autodoc: fails with ValueError when using autodoc_mock_imports
#7435: autodoc:
autodoc_typehints='description'
doesn’t suppress typehints in signature for classes/methods#7451: autodoc: fails with AttributeError when an object returns non-string object as a
__doc__
member#7423: crashed when giving a non-string object to logger
#7479: html theme: Do not include xmlns attribute with HTML 5 doctype
#7426: html theme: Escape some links in HTML templates
Release 3.0.0 (released Apr 06, 2020)¶
Dependencies¶
3.0.0b1
LaTeX: drop dependency on extractbb for image inclusion in Japanese documents as
.xbb
files are unneeded by dvipdfmx since TeXLive2015 (refs: #6189)babel-2.0 or above is available (Unpinned)
Incompatible changes¶
3.0.0b1
Drop features and APIs deprecated in 1.8.x
#247: autosummary: stub files are overwritten automatically by default. see :confval:`autosummary_generate_overwrite` to change the behavior
#5923: autodoc: the members of
object
class are not documented by default when:inherited-members:
and:special-members:
are given.#6830: py domain:
meta
fields in info-field-list becomes reserved. They are not displayed on output document now#6417: py domain: doctree of desc_parameterlist has been changed. The argument names, annotations and default values are wrapped with inline node
The structure of
sphinx.events.EventManager.listeners
has changedDue to the scoping changes for
productionlist
some uses oftoken
must be modified to include the scope which was previously ignored.#6903: Internal data structure of Python, reST and standard domains have changed. The node_id is added to the index of objects and modules. Now they contains a pair of docname and node_id for cross reference.
#7276: C++ domain: Non intended behavior is removed such as
say_hello_
links to.. cpp:function:: say_hello()
#7210: js domain: Non intended behavior is removed such as
parseInt_
links to.. js:function:: parseInt
#7229: rst domain: Non intended behavior is removed such as
numref_
links to.. rst:role:: numref
#6903: py domain: Non intended behavior is removed such as
say_hello_
links to.. py:function:: say_hello()
#7246: py domain: Drop special cross reference helper for exceptions, functions and methods
The C domain has been rewritten, with additional directives and roles. The existing ones are now more strict, resulting in new warnings.
The attribute
sphinx_cpp_tagname
in thedesc_signature_line
node has been renamed tosphinx_line_type
.#6462: double backslashes in domain directives are no longer replaced by single backslashes as default. A new configuration value :confval:`strip_signature_backslash` can be used by users to reenable it.
3.0.0 final
#7222:
sphinx.util.inspect.unwrap()
is renamed tounwrap_all()
Deprecated¶
3.0.0b1
desc_signature['first']
sphinx.directives.DescDirective
sphinx.domains.std.StandardDomain.add_object()
sphinx.domains.python.PyDecoratorMixin
sphinx.ext.autodoc.get_documenters()
sphinx.ext.autosummary.process_autosummary_toc()
sphinx.parsers.Parser.app
sphinx.testing.path.Path.text()
sphinx.testing.path.Path.bytes()
sphinx.util.inspect.getargspec()
sphinx.writers.latex.LaTeXWriter.format_docclass()
Features added¶
3.0.0b1
#247: autosummary: Add :confval:`autosummary_generate_overwrite` to overwrite old stub file
#5923: autodoc:
:inherited-members:
option takes a name of anchestor class not to document inherited members of the class and uppers#6830: autodoc: consider a member private if docstring contains
:meta private:
in info-field-list#7165: autodoc: Support Annotated type (PEP-593)
#2815: autodoc: Support singledispatch functions and methods
#7079: autodoc: :confval:`autodoc_typehints` accepts
"description"
configuration. It shows typehints as object description#7314: apidoc: Propagate
--maxdepth
option through package documents#6558: glossary: emit a warning for duplicated glossary entry
#3106: domain: Register hyperlink target for index page automatically
#6558: std domain: emit a warning for duplicated generic objects
#6830: py domain: Add new event: :event:`object-description-transform`
#6895: py domain: Do not emit nitpicky warnings for built-in types
py domain: Support lambda functions in function signature
#6417: py domain: Allow to make a style for arguments of functions and methods
#7238, #7239: py domain: Emit a warning on describing a python object if the entry is already added as the same name
#7341: py domain: type annotations in singature are converted to cross refs
Support priority of event handlers. For more detail, see
Sphinx.connect()
#3077: Implement the scoping for
productionlist
as indicated in the documentation.#1027: Support backslash line continuation in
productionlist
.#7108: config: Allow to show an error message from conf.py via
ConfigError
#7032: html: :confval:`html_scaled_image_link` will be disabled for images having
no-scaled-link
class#7144: Add CSS class indicating its domain for each desc node
#7211: latex: Use babel for Chinese document when using XeLaTeX
#6672: LaTeX: Support LaTeX Theming (experimental)
#7005: LaTeX: Add LaTeX styling macro for
kbd
role#7220: genindex: Show “main” index entries at first
#7103: linkcheck: writes all links to
output.json
#7025: html search: full text search can be disabled for individual document using
:nosearch:
file-wide metadata#7293: html search: Allow to override JavaScript splitter via
SearchLanguage.js_splitter_code
#7142: html theme: Add a theme option:
pygments_dark_style
to switch the style of code-blocks in dark modeThe C domain has been rewritten adding for example:
Cross-referencing respecting the current scope.
Possible to document anonymous entities.
More specific directives and roles for each type of entitiy, e.g., handling scoping of enumerators.
New role
c:expr
for rendering expressions and types in text.
Added
SphinxDirective.get_source_info()
andSphinxRole.get_source_info()
.#7324: sphinx-build: Emit a warning if multiple files having different file extensions for same document found
3.0.0 final
Added
ObjectDescription.transform_content()
.
Bugs fixed¶
3.0.0b1
C++, fix cross reference lookup in certain cases involving function overloads.
#5078: C++, fix cross reference lookup when a directive contains multiple declarations.
C++, suppress warnings for directly dependent typenames in cross references generated automatically in signatures.
#5637: autodoc: Incorrect handling of nested class names on show-inheritance
#7267: autodoc: error message for invalid directive options has wrong location
#7329: autodoc: info-field-list is wrongly generated from type hints into the class description even if
autoclass_content='class'
set#7331: autodoc: a cython-function is not recognized as a function
#5637: inheritance_diagram: Incorrect handling of nested class names
#7139:
code-block:: guess
does not work#7325: html: source_suffix containing dot leads to wrong source link
#7357: html: Resizing SVG image fails with ValueError
#7278: html search: Fix use of
html_file_suffix
instead ofhtml_link_suffix
in search results#7297: html theme:
bizstyle
does not supportsidebarwidth
#3842: singlehtml: Path to images broken when master doc is not in source root
#7179: std domain: Fix whitespaces are suppressed on referring GenericObject
#7289: console: use bright colors instead of bold
#1539: C, parse array types.
#2377: C, parse function pointers even in complex types.
#7345: sphinx-build: Sphinx crashes if output directory exists as a file
#7290: sphinx-build: Ignore bdb.BdbQuit when handling exceptions
#6240: napoleon: Attributes and Methods sections ignore :noindex: option
3.0.0 final
#7364: autosummary: crashed when :confval:`autosummary_generate` is False
#7370: autosummary: raises UnboundLocalError when unknown module given
#7367: C++, alternate operator spellings are now supported.
C, alternate operator spellings are now supported.
#7368: C++, comma operator in expressions, pack expansion in template argument lists, and more comprehensive error messages in some cases.
C, C++, fix crash and wrong duplicate warnings related to anon symbols.
#6477: Escape first “!” in a cross reference linking no longer possible
#7219: py domain: The index entry generated by
py:function
directive is different with one fromindex
directive with “builtin” type#7301: capital characters are not allowed for node_id
#7301: epub: duplicated node_ids are generated
#6564: html: a width of table was ignored on HTML builder
#7401: Incorrect argument is passed for :event:`env-get-outdated` handlers
#7355: autodoc: a signature of cython-function is not recognized well
#7222: autodoc:
__wrapped__
functions are not documented correctly#7409: intersphinx: ValueError is raised when an extension sets up :confval:`intersphinx_mapping` on :event:`config-inited` event
#7343: Sphinx builds has been slower since 2.4.0 on debug mode
Release 2.4.4 (released Mar 05, 2020)¶
Bugs fixed¶
#7197: LaTeX: platex cause error to build image directive with target url
#7223: Sphinx builds has been slower since 2.4.0
Release 2.4.3 (released Feb 22, 2020)¶
Bugs fixed¶
#7184: autodoc:
*args
and**kwarg
in type comments are not handled properly#7189: autodoc: classmethod coroutines are not detected
#7183: intersphinx:
:attr:
reference to property is broken#6244, #6387: html search: Search breaks/hangs when built with dirhtml builder
#7195: todo: emit doctree-resolved event with non-document node incorrectly
Release 2.4.2 (released Feb 19, 2020)¶
Bugs fixed¶
#7138: autodoc:
autodoc.typehints
crashed when variable has unbound object as a value#7156: autodoc: separator for keyword only arguments is not shown
#7146: autodoc: IndexError is raised on suppressed type_comment found
#7161: autodoc: typehints extension does not support parallel build
#7178: autodoc: TypeError is raised on fetching type annotations
#7151: crashed when extension assigns a value to
env.indexentries
#7170: text: Remove debug print
#7137: viewcode: Avoid to crash when non-python code given
Release 2.4.1 (released Feb 11, 2020)¶
Bugs fixed¶
#7120: html: crashed when on scaling SVG images which have float dimensions
#7126: autodoc: TypeError: ‘getset_descriptor’ object is not iterable
Release 2.4.0 (released Feb 09, 2020)¶
Deprecated¶
The
decode
argument ofsphinx.pycode.ModuleAnalyzer()
sphinx.directives.other.Index
sphinx.environment.temp_data['gloss_entries']
sphinx.environment.BuildEnvironment.indexentries
sphinx.environment.collectors.indexentries.IndexEntriesCollector
sphinx.ext.apidoc.INITPY
sphinx.ext.apidoc.shall_skip()
sphinx.io.FiletypeNotFoundError
sphinx.io.get_filetype()
sphinx.pycode.ModuleAnalyzer.encoding
sphinx.roles.Index
sphinx.util.detect_encoding()
sphinx.util.get_module_source()
sphinx.util.inspect.Signature
sphinx.util.inspect.safe_getmembers()
sphinx.writers.latex.LaTeXTranslator.settings.author
sphinx.writers.latex.LaTeXTranslator.settings.contentsname
sphinx.writers.latex.LaTeXTranslator.settings.docclass
sphinx.writers.latex.LaTeXTranslator.settings.docname
sphinx.writers.latex.LaTeXTranslator.settings.title
sphinx.writers.latex.ADDITIONAL_SETTINGS
sphinx.writers.latex.DEFAULT_SETTINGS
sphinx.writers.latex.LUALATEX_DEFAULT_FONTPKG
sphinx.writers.latex.PDFLATEX_DEFAULT_FONTPKG
sphinx.writers.latex.XELATEX_DEFAULT_FONTPKG
sphinx.writers.latex.XELATEX_GREEK_DEFAULT_FONTPKG
Features added¶
#6910: inheritance_diagram: Make the background of diagrams transparent
#6446: duration: Add
sphinx.ext.durations
to inspect which documents slow down the build#6837: LaTeX: Support a nested table
#7115: LaTeX: Allow to override LATEXOPTS and LATEXMKOPTS via environment variable
#6966: graphviz: Support
:class:
option#6696: html:
:scale:
option of image/figure directive not working for SVG images (imagesize-1.2.0 or above is required)#6994: imgconverter: Support illustrator file (.ai) to .png conversion
autodoc: Support Positional-Only Argument separator (PEP-570 compliant)
autodoc: Support type annotations for variables
#2755: autodoc: Add new event: :event:`autodoc-before-process-signature`
#2755: autodoc: Support type_comment style (ex.
# type: (str) -> str
) annotation (python3.8+ or typed_ast is required)#7051: autodoc: Support instance variables without defaults (PEP-526)
#6418: autodoc: Add a new extension
sphinx.ext.autodoc.typehints
. It shows typehints as object description ifautodoc_typehints = "description"
set. This is an experimental extension and it will be integrated into autodoc core in Sphinx-3.0SphinxTranslator now calls visitor/departure method for super node class if visitor/departure method for original node class not found
#6418: Add new event: :event:`object-description-transform`
py domain:
py:data
andpy:attribute
take new options named:type:
and:value:
to describe its type and initial value#6785: py domain:
:py:attr:
is able to refer properties again#6772: apidoc: Add
-q
option for quiet mode
Bugs fixed¶
#6925: html: Remove redundant type=”text/javascript” from <script> elements
#7112: html: SVG image is not layouted as float even if aligned
#6906, #6907: autodoc: failed to read the source codes encoeded in cp1251
#6961: latex: warning for babel shown twice
#7059: latex: LaTeX compilation falls into infinite loop (wrapfig issue)
#6581: latex:
:reversed:
option for toctree does not effect to LaTeX build#6559: Wrong node-ids are generated in glossary directive
#6986: apidoc: misdetects module name for .so file inside module
#6899: apidoc: private members are not shown even if
--private
given#6327: apidoc: Support a python package consisted of __init__.so file
#6999: napoleon: fails to parse tilde in :exc: role
#7019: gettext: Absolute path used in message catalogs
#7023: autodoc: nested partial functions are not listed
#7023: autodoc: partial functions imported from other modules are listed as module members without :impoprted-members: option
#6889: autodoc: Trailing comma in
:members::
option causes cryptic warning#6568: autosummary:
autosummary_imported_members
is ignored on generating a stub file for submodule#7055: linkcheck: redirect is treated as an error
#7088: HTML template: If
navigation_with_keys
option is activated, modifier keys are ignored, which means the feature can interfere with browser features#7090: std domain: Can’t assign numfig-numbers for custom container nodes
#7106: std domain: enumerated nodes are marked as duplicated when extensions call
note_explicit_target()
#7095: dirhtml: Cross references are broken via intersphinx and
:doc:
roleC++:
Don’t crash when using the
struct
role in some cases.Don’t warn when using the
var
/member
role for function parameters.Render call and braced-init expressions correctly.
#7097: Filenames of images generated by
sphinx.transforms.post_transforms.images.ImageConverter
or its subclasses (used for latex build) are now sanitized, to prevent broken paths
Release 2.3.0 (released Dec 15, 2019)¶
Incompatible changes¶
#6742:
end-before
option ofliteralinclude
directive does not match the first line of the code block.#1331: Change default User-Agent header to
"Sphinx/X.Y.Z requests/X.Y.Z python/X.Y.Z"
. It can be changed via :confval:`user_agent`.#6867: text: content of admonitions starts after a blank line
Deprecated¶
sphinx.builders.gettext.POHEADER
sphinx.io.SphinxStandaloneReader.app
sphinx.io.SphinxStandaloneReader.env
sphinx.util.texescape.tex_escape_map
sphinx.util.texescape.tex_hl_escape_map_new
sphinx.writers.latex.LaTeXTranslator.no_contractions
Features added¶
#6707: C++, support bit-fields.
#267: html: Eliminate prompt characters of doctest block from copyable text
#6548: html: Use favicon for OpenSearch if available
#6729: html theme: agogo theme now supports
rightsidebar
option#6780: Add PEP-561 Support
#6762: latex: Allow to load additional LaTeX packages via
extrapackages
key of :confval:`latex_elements`#1331: Add new config variable: :confval:`user_agent`
#6000: LaTeX: have backslash also be an inline literal word wrap break character
#4186: LaTeX: Support upLaTeX as a new :confval:`latex_engine` (experimental)
#6812: Improve a warning message when extensions are not parallel safe
#6818: Improve Intersphinx performance for multiple remote inventories.
#2546: apidoc: .so file support
#6798: autosummary: emit
autodoc-skip-member
event on generating stub file#6483: i18n: make explicit titles in toctree translatable
#6816: linkcheck: Add :confval:`linkcheck_auth` option to provide authentication information when doing
linkcheck
builds#6872: linkcheck: Handles HTTP 308 Permanent Redirect
#6613: html: Wrap section number in span tag
#6781: gettext: Add :confval:`gettext_last_translator' and :confval:`gettext_language_team` to customize headers of POT file
Bugs fixed¶
#6668: LaTeX: Longtable before header has incorrect distance (refs: latex3/latex2e#173)
#6618: LaTeX: Avoid section names at the end of a page
#6738: LaTeX: Do not replace unicode characters by LaTeX macros on unicode supported LaTeX engines: ¶, §, €, ∞, ±, →, ‣, –, superscript and subscript digits go through “as is” (as default OpenType font supports them)
#6704: linkcheck: Be defensive and handle newly defined HTTP error code
#6806: linkcheck: Failure on parsing content
#6655: image URLs containing
data:
causes gettext builder crashed#6584: i18n: Error when compiling message catalogs on Hindi
#6718: i18n: KeyError is raised if section title and table title are same
#6743: i18n: :confval:`rst_prolog` breaks the translation
#6708: mathbase: Some deprecated functions have removed
#6709: autodoc: mock object does not work as a class decorator
#5070: epub: Wrong internal href fragment links
#6712: Allow not to install sphinx.testing as runtime (mainly for ALT Linux)
#6741: html: search result was broken with empty :confval:`html_file_suffix`
#6001: LaTeX does not wrap long code lines at backslash character
#6804: LaTeX: PDF build breaks if admonition of danger type contains code-block long enough not to fit on one page
#6809: LaTeX: code-block in a danger type admonition can easily spill over bottom of page
#6793: texinfo: Code examples broken following “sidebar”
#6813: An orphan warning is emitted for included document on Windows. Thanks to @drillan
#6850: Fix smartypants module calls re.sub() with wrong options
#6824: HTML search: If a search term is partially matched in the title and fully matched in a text paragraph on the same page, the search does not include this match.
#6848: config.py shouldn’t pop extensions from overrides
#6867: text: extra spaces are inserted to hyphenated words on folding lines
#6886: LaTeX: xelatex converts straight double quotes into right curly ones (shows when :confval:`smartquotes` is
False
)#6890: LaTeX: even with smartquotes off, PDF output transforms straight quotes and consecutive hyphens into curly quotes and dashes
#6876: LaTeX: multi-line display of authors on title page has ragged edges
#6887: Sphinx crashes with docutils-0.16b0
#6920: sphinx-build: A console message is wrongly highlighted
#6900: sphinx-build:
-D
option does not considers0
and1
as a boolean value
Release 2.2.2 (released Dec 03, 2019)¶
Incompatible changes¶
#6803: For security reason of python, parallel mode is disabled on macOS and Python3.8+
Bugs fixed¶
#6776: LaTeX: 2019-10-01 LaTeX release breaks
sphinxcyrillic.sty
#6815: i18n: French, Hindi, Chinese, Japanese and Korean translation messages has been broken
#6803: parallel build causes AttributeError on macOS and Python3.8
Release 2.2.1 (released Oct 26, 2019)¶
Bugs fixed¶
#6641: LaTeX: Undefined control sequence
\sphinxmaketitle
#6710: LaTeX not well configured for Greek language as main language
#6759: validation of html static paths and extra paths no longer throws an error if the paths are in different directories
Release 2.2.0 (released Aug 19, 2019)¶
Incompatible changes¶
apidoc: template files are renamed to
.rst_t
html: Field lists will be styled by grid layout
Deprecated¶
sphinx.domains.math.MathDomain.add_equation()
sphinx.domains.math.MathDomain.get_next_equation_number()
The
info
andwarn
arguments ofsphinx.ext.autosummary.generate.generate_autosummary_docs()
sphinx.ext.autosummary.generate._simple_info()
sphinx.ext.autosummary.generate._simple_warn()
sphinx.ext.todo.merge_info()
sphinx.ext.todo.process_todo_nodes()
sphinx.ext.todo.process_todos()
sphinx.ext.todo.purge_todos()
Features added¶
#5124: graphviz:
:graphviz_dot:
option is renamed to:layout:
#1464: html: emit a warning if :confval:`html_static_path` and :confval:`html_extra_path` directories are inside output directory
#6514: html: Add a label to search input for accessability purposes
#5602: apidoc: Add
--templatedir
option#6475: Add
override
argument toapp.add_autodocumenter()
#6310: imgmath: let :confval:`imgmath_use_preview` work also with the SVG format for images rendering inline math
#6533: LaTeX: refactor visit_enumerated_list() to use
\sphinxsetlistlabels
#6628: quickstart: Use
https://docs.python.org/3/
for default setting of :confval:`intersphinx_mapping`#6419: sphinx-build: give reasons why rebuilded
Bugs fixed¶
py domain: duplicated warning does not point the location of source code
#6499: html: Sphinx never updates a copy of :confval:`html_logo` even if original file has changed
#1125: html theme: scrollbar is hard to see on classic theme and macOS
#5502: linkcheck: Consider HTTP 503 response as not an error
#6439: Make generated download links reproducible
#6486: UnboundLocalError is raised if broken extension installed
#6567: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to
__init__()
and__new__()
#6574: autodoc: :confval:`autodoc_member_order` does not refer order of imports when
'bysource'
order#6574: autodoc: missing type annotation for variadic and keyword parameters
#6589: autodoc: Formatting issues with autodoc_typehints=’none’
#6605: autodoc: crashed when target code contains custom method-like objects
#6498: autosummary: crashed with wrong autosummary_generate setting
#6507: autosummary: crashes without no autosummary_generate setting
#6511: LaTeX: autonumbered list can not be customized in LaTeX since Sphinx 1.8.0 (refs: #6533)
#6531: Failed to load last environment object when extension added
#736: Invalid sort in pair index
#6527: :confval:`last_updated` wrongly assumes timezone as UTC
#5592: std domain:
option
directive registers an index entry for each comma separated option#6549: sphinx-build: Escaped characters in error messages
#6545: doctest comments not getting trimmed since Sphinx 1.8.0
#6561: glossary: Wrong hyperlinks are generated for non alphanumeric terms
#6620: i18n: classifiers of definition list are not translated with docutils-0.15
#6474:
DocFieldTransformer
raises AttributeError when given directive is not a subclass of ObjectDescription
Release 2.1.2 (released Jun 19, 2019)¶
Bugs fixed¶
#6497: custom lexers fails highlighting when syntax error
#6478, #6488: info field lists are incorrectly recognized
Release 2.1.1 (released Jun 10, 2019)¶
Incompatible changes¶
#6447: autodoc: Stop to generate document for undocumented module variables
Bugs fixed¶
#6442: LaTeX: admonitions of
note
type can get separated from immediately preceding section title by pagebreak#6448: autodoc: crashed when autodocumenting classes with
__slots__ = None
#6451: autodoc: generates docs for “optional import”ed modules as variables
#6452: autosummary: crashed when generating document of properties
#6455: napoleon: docstrings for properties are not processed
#6436: napoleon: “Unknown target name” error if variable name ends with underscore
#6440: apidoc: missing blank lines between modules
Release 2.1.0 (released Jun 02, 2019)¶
Incompatible changes¶
Ignore filenames without file extension given to
Builder.build_specific()
API directly#6230: The anchor of term in glossary directive is changed if it is consisted by non-ASCII characters
#4550: html: Centering tables by default using CSS
#6239: latex: xelatex and xeCJK are used for Chinese documents by default
Sphinx.add_lexer()
now takes a Lexer class instead of instance. An instance of lexers are still supported until Sphinx-3.x.
Deprecated¶
sphinx.builders.latex.LaTeXBuilder.apply_transforms()
sphinx.builders._epub_base.EpubBuilder.esc()
sphinx.directives.Acks
sphinx.directives.Author
sphinx.directives.Centered
sphinx.directives.Class
sphinx.directives.CodeBlock
sphinx.directives.Figure
sphinx.directives.HList
sphinx.directives.Highlight
sphinx.directives.Include
sphinx.directives.Index
sphinx.directives.LiteralInclude
sphinx.directives.Meta
sphinx.directives.Only
sphinx.directives.SeeAlso
sphinx.directives.TabularColumns
sphinx.directives.TocTree
sphinx.directives.VersionChange
sphinx.domains.python.PyClassmember
sphinx.domains.python.PyModulelevel
sphinx.domains.std.StandardDomain._resolve_citation_xref()
sphinx.domains.std.StandardDomain.note_citations()
sphinx.domains.std.StandardDomain.note_citation_refs()
sphinx.domains.std.StandardDomain.note_labels()
sphinx.environment.NoUri
sphinx.ext.apidoc.format_directive()
sphinx.ext.apidoc.format_heading()
sphinx.ext.apidoc.makename()
sphinx.ext.autodoc.importer.MockFinder
sphinx.ext.autodoc.importer.MockLoader
sphinx.ext.autodoc.importer.mock()
sphinx.ext.autosummary.autolink_role()
sphinx.ext.imgmath.DOC_BODY
sphinx.ext.imgmath.DOC_BODY_PREVIEW
sphinx.ext.imgmath.DOC_HEAD
sphinx.transforms.CitationReferences
sphinx.transforms.SmartQuotesSkipper
sphinx.util.docfields.DocFieldTransformer.preprocess_fieldtypes()
sphinx.util.node.find_source_node()
sphinx.util.i18n.find_catalog()
sphinx.util.i18n.find_catalog_files()
sphinx.util.i18n.find_catalog_source_files()
For more details, see deprecation APIs list.
Features added¶
Add a helper class
sphinx.transforms.post_transforms.SphinxPostTransform
Add helper methods
PythonDomain.note_module()
PythonDomain.note_object()
SphinxDirective.set_source_info()
#6180: Support
--keep-going
with BuildDoc setup commandmath
directive now supports:class:
optiontodo:
todo
directive now supports:name:
optionEnable override via environment of
SPHINXOPTS
andSPHINXBUILD
Makefile variables (refs: #6232, #6303)#6287: autodoc: Unable to document bound instance methods exported as module functions
#6289: autodoc: :confval:`autodoc_default_options` now supports
imported-members
option#4777: autodoc: Support coroutine
#744: autodoc: Support abstractmethod
#6325: autodoc: Support attributes in __slots__. For dict-style __slots__, autodoc considers values as a docstring of the attribute
#6361: autodoc: Add :confval:`autodoc_typehints` to suppress typehints from signature
#1063: autodoc:
automodule
directive now handles undocumented module level variables#6212 autosummary: Add :confval:`autosummary_imported_members` to display imported members on autosummary
#6271:
make clean
is catastrophically broken if building into ‘.’#6363: Support
%O%
environment variable in make.bat#4777: py domain: Add
:async:
option topy:function
directivepy domain: Add new options to
py:method
directive:abstractmethod:
:async:
:classmethod:
:property:
:staticmethod:
rst domain: Add
directive:option
directive to describe the option for directive#6306: html: Add a label to search form for accessability purposes
#4390: html: Consistent and semantic CSS for signatures
#6358: The
rawsource
property ofproduction
nodes now contains the full production rule#6373: autosectionlabel: Allow suppression of warnings
coverage: Support a new
coverage_ignore_pyobjects
option#6239: latex: Support to build Chinese documents
Bugs fixed¶
#6230: Inappropriate node_id has been generated by glossary directive if term is consisted by non-ASCII characters
#6213: ifconfig: contents after headings are not shown
commented term in glossary directive is wrongly recognized
#6299: rst domain: rst:directive directive generates waste space
#6379: py domain: Module index (py-modindex.html) has duplicate titles
#6331: man: invalid output when doctest follows rubric
#6351: “Hyperlink target is not referenced” message is shown even if referenced
#6165: autodoc:
tab_width
setting of docutils has been ignored#6347: autodoc: crashes with a plain Tuple on Python 3.6 and 3.5
#6311: autosummary: autosummary table gets confused by complex type hints
#6350: autosummary: confused by an argument having some kind of default value
Generated Makefiles lack a final EOL (refs: #6232)
#6375: extlinks: Cannot escape angle brackets in link caption
#6378: linkcheck: Send commonly used User-Agent
#6387: html search: failed to search document with haiku and scrolls themes
#6408: html search: Fix the ranking of search results
#6406: Wrong year is returned for
SOURCE_DATE_EPOCH
#6402: image directive crashes by unknown image format
#6286: C++, allow 8 and 9 in hexadecimal integer literals.
#6305: Fix the string in quickstart for ‘path’ argument of parser
LaTeX: Figures in admonitions produced errors (refs: #6364)
Release 2.0.1 (released Apr 08, 2019)¶
Bugs fixed¶
LaTeX: some system labels are not translated
RemovedInSphinx30Warning is marked as pending
deprecation warnings are not emitted
sphinx.application.CONFIG_FILENAME
sphinx.builders.htmlhelp
#6208: C++, properly parse full xrefs that happen to have a short xref as prefix
#6220, #6225: napoleon: AttributeError is raised for raised section having references
#6245: circular import error on importing SerializingHTMLBuilder
#6243: LaTeX: ‘releasename’ setting for latex_elements is ignored
#6244: html: Search function is broken with 3rd party themes
#6263: html: HTML5Translator crashed with invalid field node
#6262: html theme: The style of field lists has changed in bizstyle theme
Release 2.0.0 (released Mar 29, 2019)¶
Dependencies¶
2.0.0b1
LaTeX builder now depends on TeX Live 2015 or above.
LaTeX builder (with
'pdflatex'
:confval:`latex_engine`) will process Unicode Greek letters in text (not in math mark-up) via the text font and will not escape them to math mark-up. See the discussion of the'fontenc'
key of :confval:`latex_elements`; such (optional) support for Greek adds, for example on Ubuntu xenial, thetexlive-lang-greek
and (if default font set-up is not modified)cm-super(-minimal)
as additional Sphinx LaTeX requirements.LaTeX builder with :confval:`latex_engine` set to
'xelatex'
or to'lualatex'
requires (by default) theFreeFont
fonts, which in Ubuntu xenial are provided by packagefonts-freefont-otf
, and e.g. in Fedora 29 via packagetexlive-gnu-freefont
.requests 2.5.0 or above
The six package is no longer a dependency
The sphinxcontrib-websupport package is no longer a dependency
Some packages are separated to sub packages:
sphinxcontrib.applehelp
sphinxcontrib.devhelp
sphinxcontrib.htmlhelp
sphinxcontrib.jsmath
sphinxcontrib.serializinghtml
sphinxcontrib.qthelp
Incompatible changes¶
2.0.0b1
Drop python 2.7 and 3.4 support
Drop docutils 0.11 support
Drop features and APIs deprecated in 1.7.x
The default setting for :confval:`master_doc` is changed to
'index'
which has been longly used as default of sphinx-quickstart.LaTeX: Move message resources to
sphinxmessage.sty
LaTeX: Stop using
\captions<lang>
macro for some labelsLaTeX: for
'xelatex'
and'lualatex'
, use theFreeFont
OpenType fonts as default choice (refs: #5645)LaTeX:
'xelatex'
and'lualatex'
now use\small
in code-blocks (due toFreeMono
character width) like'pdflatex'
already did (due toCourier
character width). You may need to adjust this via :confval:`latex_elements`'fvset'
key, in case of usage of some other OpenType fonts (refs: #5768)LaTeX: Greek letters in text are not escaped to math mode mark-up, and they will use the text font not the math font. The
LGR
font encoding must be added to the'fontenc'
key of :confval:`latex_elements` for this to work (only if it is needed by the document, of course).LaTeX: setting the :confval:`language` to
'en'
triggeredSonny
option offncychap
, now it isBjarne
to match case of no language specified. (refs: #5772)#5770: doctest: Follow :confval:`highlight_language` on highlighting doctest block. As a result, they are highlighted as python3 by default.
The order of argument for
HTMLTranslator
,HTML5Translator
andManualPageTranslator
are changedLaTeX: hard-coded redefinitions of
\l@section
and\l@subsection
formerly done during loading of'manual'
docclass get executed later, at time of\sphinxtableofcontents
. This means that custom user definitions from LaTeX preamble now get overwritten. Use\sphinxtableofcontentshook
to insert custom user definitions. See Macros.quickstart: Simplify generated
conf.py
#4148: quickstart: some questions are removed. They are still able to specify via command line options
websupport: unbundled from sphinx core. Please use sphinxcontrib-websupport
C++, the visibility of base classes is now always rendered as present in the input. That is,
private
is now shown, where it was ellided before.LaTeX: graphics inclusion of oversized images rescales to not exceed the text width and height, even if width and/or height option were used. (refs: #5956)
epub:
epub_title
defaults to the :confval:`project` option#4550: All tables and figures without
align
option are displayed to center#4587: html: Output HTML5 by default
2.0.0b2
texinfo: image files are copied into
name-figure
directory
Deprecated¶
2.0.0b1
Support for evaluating Python 2 syntax is deprecated. This includes configuration files which should be converted to Python 3.
The arguments of
EpubBuilder.build_mimetype()
,EpubBuilder.build_container()
,EpubBuilder.bulid_content()
,EpubBuilder.build_toc()
andEpubBuilder.build_epub()
The arguments of
Epub3Builder.build_navigation_doc()
The config variables
The
encoding
argument ofautodoc.Documenter.get_doc()
,autodoc.DocstringSignatureMixin.get_doc()
,autodoc.DocstringSignatureMixin._find_signature()
, andautodoc.ClassDocumenter.get_doc()
are deprecated.The
importer
argument ofsphinx.ext.autodoc.importer._MockModule
The
nodetype
argument ofsphinx.search.WordCollector. is_meta_keywords()
The
suffix
argument ofenv.doc2path()
is deprecated.The string style
base
argument ofenv.doc2path()
is deprecated.The fallback to allow omitting the
filename
argument from an overriddenIndexBuilder.feed()
method is deprecated.sphinx.addnodes.abbreviation
sphinx.application.Sphinx._setting_up_extension
sphinx.builders.epub3.Epub3Builder.validate_config_value()
sphinx.builders.html.SingleFileHTMLBuilder
sphinx.builders.htmlhelp.HTMLHelpBuilder.open_file()
sphinx.cmd.quickstart.term_decode()
sphinx.cmd.quickstart.TERM_ENCODING
sphinx.config.check_unicode()
sphinx.config.string_classes
sphinx.domains.cpp.DefinitionError.description
sphinx.domains.cpp.NoOldIdError.description
sphinx.domains.cpp.UnsupportedMultiCharacterCharLiteral.decoded
sphinx.ext.autodoc.importer._MockImporter
sphinx.ext.autosummary.Autosummary.warn()
sphinx.ext.autosummary.Autosummary.genopt
sphinx.ext.autosummary.Autosummary.warnings
sphinx.ext.autosummary.Autosummary.result
sphinx.ext.doctest.doctest_encode()
sphinx.io.SphinxBaseFileInput
sphinx.io.SphinxFileInput.supported
sphinx.io.SphinxRSTFileInput
sphinx.registry.SphinxComponentRegistry.add_source_input()
sphinx.roles.abbr_role()
sphinx.roles.emph_literal_role()
sphinx.roles.menusel_role()
sphinx.roles.index_role()
sphinx.roles.indexmarkup_role()
sphinx.testing.util.remove_unicode_literal()
sphinx.util.attrdict
sphinx.util.force_decode()
sphinx.util.get_matching_docs()
sphinx.util.inspect.Parameter
sphinx.util.jsonimpl
sphinx.util.osutil.EEXIST
sphinx.util.osutil.EINVAL
sphinx.util.osutil.ENOENT
sphinx.util.osutil.EPIPE
sphinx.util.osutil.walk()
sphinx.util.PeekableIterator
sphinx.util.pycompat.NoneType
sphinx.util.pycompat.TextIOWrapper
sphinx.util.pycompat.UnicodeMixin
sphinx.util.pycompat.htmlescape
sphinx.util.pycompat.indent
sphinx.util.pycompat.sys_encoding
sphinx.util.pycompat.terminal_safe()
sphinx.util.pycompat.u
sphinx.writers.latex.ExtBabel
sphinx.writers.latex.LaTeXTranslator._make_visit_admonition()
sphinx.writers.latex.LaTeXTranslator.babel_defmacro()
sphinx.writers.latex.LaTeXTranslator.collect_footnotes()
sphinx.writers.latex.LaTeXTranslator.generate_numfig_format()
sphinx.writers.texinfo.TexinfoTranslator._make_visit_admonition()
sphinx.writers.text.TextTranslator._make_depart_admonition()
template variables for LaTeX template
logo
numfig_format
pageautorefname
translatablestrings
For more details, see deprecation APIs list.
Features added¶
2.0.0b1
#1618: The search results preview of generated HTML documentation is reader-friendlier: instead of showing the snippets as raw reStructuredText markup, Sphinx now renders the corresponding HTML. This means the Sphinx extension Sphinx: pretty search results is no longer necessary. Note that changes to the search function of your custom or 3rd-party HTML template might overwrite this improvement.
#4182: autodoc: Support :confval:`suppress_warnings`
#5533: autodoc: :confval:`autodoc_default_options` supports
member-order
#5394: autodoc: Display readable names in type annotations for mocked objects
#5459: autodoc: :confval:`autodoc_default_options` accepts
True
as a value#1148: autodoc: Add
autodecorator
directive for decorators#5635: autosummary: Add :confval:`autosummary_mock_imports` to mock external libraries on importing targets
#4018: htmlhelp: Add :confval:`htmlhelp_file_suffix` and :confval:`htmlhelp_link_suffix`
#5559: text: Support complex tables (colspan and rowspan)
LaTeX: support rendering (not in math, yet) of Greek and Cyrillic Unicode letters in non-Cyrillic document even with
'pdflatex'
as :confval:`latex_engine` (refs: #5645)#5660: The
versionadded
,versionchanged
anddeprecated
directives are now generated with their own specific CSS classes (added
,changed
anddeprecated
, respectively) in addition to the genericversionmodified
class.#5841: apidoc: Add –extensions option to sphinx-apidoc
#4981: C++, added an alias directive for inserting lists of declarations, that references existing declarations (e.g., for making a synopsis).
C++: add
cpp:struct
to complementcpp:class
.#1341 the HTML search considers words that contain a search term of length three or longer a match.
#4611: epub: Show warning for duplicated ToC entries
#1851: Allow to omit an argument for
code-block
directive. If omitted, it followshighlight
or :confval:`highlight_language`#4587: html: Add :confval:`html4_writer` to use old HTML4 writer
#6016: HTML search: A placeholder for the search summary prevents search result links from changing their position when the search terminates. This makes navigating search results easier.
#5196: linkcheck also checks remote images exist
#5924: githubpages: create CNAME file for custom domains when :confval:`html_baseurl` set
#4261: autosectionlabel: restrict the labeled sections by new config value; :confval:`autosectionlabel_maxdepth`
Bugs fixed¶
2.0.0b1
#1682: LaTeX: writer should not translate Greek unicode, but use textgreek package
#5247: LaTeX: PDF does not build with default font config for Russian language and
'xelatex'
or'lualatex'
as :confval:`latex_engine` (refs: #5251)#5248: LaTeX: Greek letters in section titles disappear from PDF bookmarks
#5249: LaTeX: Unicode Greek letters in math directive break PDF build (fix requires extra set-up, see :confval:`latex_elements`
'textgreek'
key and/or :confval:`latex_engine` setting)#5772: LaTeX: should the Bjarne style of fncychap be used for English also if passed as language option?
#5179: LaTeX: (lualatex only) escaping of
>
by\textgreater{}
is not enough as\textgreater{}\textgreater{}
applies TeX-ligatureLaTeX: project name is not escaped if :confval:`latex_documents` omitted
LaTeX: authors are not shown if :confval:`latex_documents` omitted
HTML: Invalid HTML5 file is generated for a glossary having multiple terms for one description (refs: #4611)
QtHelp: OS dependent path separator is used in .qhp file
HTML search: search always returns nothing when multiple search terms are used and one term is shorter than three characters
2.0.0b2
#6096: html: Anchor links are not added to figures
#3620: html: Defer searchindex.js rather than loading it via ajax
#6113: html: Table cells and list items have large margins
#5508:
linenothreshold
option forhighlight
directive was ignoredtexinfo:
make install-info
causes syntax errortexinfo:
make install-info
fails on macOS#3079: texinfo: image files are not copied on
make install-info
#5391: A cross reference in heading is rendered as literal
#5946: C++, fix
cpp:alias
problems in LaTeX (and singlehtml)#6147: classes attribute of
citation_reference
node is lostAssertionError is raised when custom
citation_reference
node having classes attribute refers missing citation (refs: #6147)#2155: Support
code
directiveC++, fix parsing of braced initializers.
#6172: AttributeError is raised for old styled index nodes
#4872: inheritance_diagram: correctly describe behavior of
parts
option in docs, allow negative values.#6178: i18n: Captions missing in translations for hidden TOCs
2.0.0 final
#6196: py domain: unexpected prefix is generated
Testing¶
2.0.0b1
Stop to use
SPHINX_TEST_TEMPDIR
envvar
2.0.0b2
Add a helper function:
sphinx.testing.restructuredtext.parse()
Release 1.8.5 (released Mar 10, 2019)¶
Bugs fixed¶
LaTeX: Remove extraneous space after author names on PDF title page (refs: #6004)
#6026: LaTeX: A cross reference to definition list does not work
#6046: LaTeX:
TypeError
is raised when invalid latex_elements given#6067: LaTeX: images having a target are concatenated to next line
#6067: LaTeX: images having a target are not aligned even if specified
#6149: LaTeX:
:index:
role in titles causesUse of \@icentercr doesn't match its definition
error on latexpdf build#6019: imgconverter: Including multipage PDF fails
#6047: autodoc:
autofunction
emits a warning for method objects#6028: graphviz: Ensure the graphviz filenames are reproducible
#6068: doctest:
skipif
option may remove the code block from documentation#6136:
:name:
option formath
directive causes a crash#6139: intersphinx: ValueError on failure reporting
#6135: changes: Fix UnboundLocalError when any module found
#3859: manpage: code-block captions are not displayed correctly
Release 1.8.4 (released Feb 03, 2019)¶
Bugs fixed¶
#3707: latex: no bold checkmark (✔) available.
#5605: with the documentation language set to Chinese, English words could not be searched.
#5889: LaTeX: user
numfig_format
is stripped of spaces and may cause build failureC++, fix hyperlinks for declarations involving east cv-qualifiers.
#5755: C++, fix duplicate declaration error on function templates with constraints in the return type.
C++, parse unary right fold expressions and binary fold expressions.
pycode could not handle egg files on windows
#5928: KeyError: ‘DOCUTILSCONFIG’ when running build
#5936: LaTeX: PDF build broken by inclusion of image taller than page height in an admonition
#5231: “make html” does not read and build “po” files in “locale” dir
#5954:
:scale:
image option may break PDF build if image in an admonition#5966: mathjax has not been loaded on incremental build
#5960: LaTeX: modified PDF layout since September 2018 TeXLive update of
parskip.sty
#5948: LaTeX: duplicated labels are generated for sections
#5958: versionadded directive causes crash with Python 3.5.0
#5995: autodoc: autodoc_mock_imports conflict with metaclass on Python 3.7
#5871: texinfo: a section title
.
is not allowed
Release 1.8.3 (released Dec 26, 2018)¶
Features added¶
LaTeX: it is possible to insert custom material to appear on back of title page, see discussion of
'maketitle'
key of :confval:`latex_elements` ('manual'
docclass only)
Bugs fixed¶
#5725: mathjax: Use CDN URL for “latest” version by default
#5460: html search does not work with some 3rd party themes
#5520: LaTeX, caption package incompatibility since Sphinx 1.6
#5614: autodoc: incremental build is broken when builtin modules are imported
#5627: qthelp: index.html missing in QtHelp
#5659: linkcheck: crashes for a hyperlink containing multibyte character
#5754: DOC: Fix some mistakes in /latex
#5810: LaTeX: sphinxVerbatim requires explicit “hllines” set-up since 1.6.6 (refs: #1238)
#5636: C++, fix parsing of floating point literals.
#5496 (again): C++, fix assertion in partial builds with duplicates.
#5724: quickstart: sphinx-quickstart fails when $LC_ALL is empty
#1956: Default conf.py is not PEP8-compliant
#5849: LaTeX: document class
\maketitle
is overwritten with no possibility to use original meaning in place of Sphinx custom one#5834: apidoc: wrong help for
--tocfile
#5800: todo: crashed if todo is defined in TextElement
#5846: htmlhelp: convert hex escaping to decimal escaping in .hhc/.hhk files
htmlhelp: broken .hhk file generated when title contains a double quote
Release 1.8.2 (released Nov 11, 2018)¶
Incompatible changes¶
#5497: Do not include MathJax.js and jsmath.js unless it is really needed
Features added¶
#5471: Show appropriate deprecation warnings
Bugs fixed¶
#5490: latex: enumerated list causes a crash with recommonmark
#5492: sphinx-build fails to build docs w/ Python < 3.5.2
#3704: latex: wrong
\label
positioning for figures with a legend#5496: C++, fix assertion when a symbol is declared more than twice.
#5493: gettext: crashed with broken template
#5495: csv-table directive with file option in included file is broken (refs: #4821)
#5498: autodoc: unable to find type hints for a
functools.partial
#5480: autodoc: unable to find type hints for unresolvable Forward references
#5419: incompatible math_block node has been generated
#5548: Fix ensuredir() in case of pre-existing file
#5549: graphviz Correctly deal with non-existing static dir
#3002: i18n: multiple footnote_references referring same footnote cause duplicated node_ids
#5563: latex: footnote_references generated by extension causes a LaTeX builder crash
#5561: make all-pdf fails with old xindy version
#5557: quickstart: –no-batchfile isn’t honored
#3080: texinfo: multiline rubrics are broken
#3080: texinfo: multiline citations are broken
Release 1.8.1 (released Sep 22, 2018)¶
Incompatible changes¶
LaTeX
\pagestyle
commands have been moved to the LaTeX template. No changes in PDF, except possibly if\sphinxtableofcontents
, which contained them, had been customized inconf.py
. (refs: #5455)
Bugs fixed¶
#5418: Incorrect default path for sphinx-build -d/doctrees files
#5421: autodoc emits deprecation warning for :confval:`autodoc_default_flags`
#5422: lambda object causes PicklingError on storing environment
#5417: Sphinx fails to build with syntax error in Python 2.7.5
#4911: add latexpdf to make.bat for non make-mode
#5436: Autodoc does not work with enum subclasses with properties/methods
#5437: autodoc: crashed on modules importing eggs
#5433: latex: ImportError: cannot import name ‘DEFAULT_SETTINGS’
#5431: autodoc:
autofunction
emits a warning for callable objects#5457: Fix TypeError in error message when override is prohibited
#5453: PDF builds of ‘howto’ documents have no page numbers
#5463: mathbase: math_role and MathDirective was disappeared in 1.8.0
#5454: latex: Index has disappeared from PDF for Japanese documents
#5432: py domain:
:type:
field can’t process:term:
references#5426: py domain: TypeError has been raised for class attribute
Release 1.8.0 (released Sep 13, 2018)¶
Dependencies¶
1.8.0b1
LaTeX: :confval:`latex_use_xindy`, if
True
(default forxelatex/lualatex
), instructsmake latexpdf
to use xindy for general index. Make sure your LaTeX distribution includes it. (refs: #5134)LaTeX:
latexmk
is required formake latexpdf
on Windows
Incompatible changes¶
1.8.0b2
#5282: html theme: refer
pygments_style
settings of HTML themes preferentiallyThe URL of download files are changed
#5127: quickstart:
Makefile
andmake.bat
are not overwritten if exists
1.8.0b1
#5156: the
sphinx.ext.graphviz: extension runs `dot
in the directory of the document being built instead of in the root directory of the documentation.#4460: extensions which stores any data to environment should return the version of its env data structure as metadata. In detail, please see Extension metadata.
Sphinx expects source parser modules to have supported file formats as
Parser.supported
attributeThe default value of :confval:`epub_author` and :confval:`epub_publisher` are changed from
'unknown'
to the value of :confval:`author`. This is same as aconf.py
file sphinx-build generates.The
gettext_compact
attribute is removed fromdocument.settings
object. Please useconfig.gettext_compact
instead.The processing order on reading phase is changed. smart_quotes, sphinx domains, :event:`doctree-read` event and versioning doctrees are invoked earlier than so far. For more details, please read a description of
Sphinx.add_transform()
#4827: All
substitution_definition
nodes are removed from doctree on reading phasedocutils.conf
in$HOME
or/etc
directories are ignored. Onlydocutils.conf
from confdir is obeyed.#789:
:samp:
role supports to escape curly braces with backslash#4811: The files under :confval:`html_static_path` are excluded from source files.
latex: Use
\sphinxcite
for citation references instead\hyperref
The config value
viewcode_import
is renamed to :confval:`viewcode_follow_imported_members` (refs: #4035)#1857: latex: :confval:`latex_show_pagerefs` does not add pagerefs for citations
#4648: latex: Now “rubric” elements are rendered as unnumbered section title
#4983: html: The anchor for productionlist tokens has been changed
Modifying a template variable
script_files
in templates is allowed now. Please useapp.add_js_file()
instead.#5072: Save environment object also with only new documents
#5035: qthelp builder allows dashes in :confval:`qthelp_namespace`
LaTeX: with lualatex or xelatex use by default xindy as UTF-8 able replacement of makeindex (refs: #5134). After upgrading Sphinx, please clean latex build repertory of existing project before new build.
#5163: html: hlist items are now aligned to top
highlightlang
directive is processed on resolving phase#4000: LaTeX: template changed. Following elements moved to it:
\begin{document}
shorthandoff
variablemaketitle
variabletableofcontents
variable
Deprecated¶
1.8.0b2
sphinx.io.SphinxI18nReader.set_lineno_for_reporter()
is deprecatedsphinx.io.SphinxI18nReader.line
is deprecatedsphinx.util.i18n.find_catalog_source_file()
has changed; the gettext_compact argument has been deprecated#5403:
sphinx.util.images.guess_mimetype()
has changed; the content argument has been deprecated
1.8.0b1
:confval:`source_parsers` is deprecated
:confval:`autodoc_default_flags` is deprecated
quickstart:
--epub
option becomes default, so it is deprecatedDrop function based directive support. For now, Sphinx only supports class based directives (see
Directive
)sphinx.util.docutils.directive_helper()
is deprecatedsphinx.cmdline
is deprecatedsphinx.make_mode
is deprecatedsphinx.locale.l_()
is deprecated#2157: helper function
warn()
for HTML themes is deprecatedapp.override_domain()
is deprecatedapp.add_stylesheet()
is deprecatedapp.add_javascript()
is deprecatedapp.import_object()
is deprecatedapp.add_source_parser()
has changed; the suffix argument has been deprecatedsphinx.versioning.prepare()
is deprecatedConfig.__init__()
has changed; the dirname, filename and tags argument has been deprecatedConfig.check_types()
is deprecatedConfig.check_unicode()
is deprecatedsphinx.application.CONFIG_FILENAME
is deprecatedhighlightlang
directive is deprecatedBuildEnvironment.load()
is deprecatedBuildEnvironment.loads()
is deprecatedBuildEnvironment.frompickle()
is deprecatedenv.read_doc()
is deprecatedenv.update()
is deprecatedenv._read_serial()
is deprecatedenv._read_parallel()
is deprecatedenv.write_doctree()
is deprecatedenv._nitpick_ignore
is deprecatedenv.versionchanges
is deprecatedenv.dump()
is deprecatedenv.dumps()
is deprecatedenv.topickle()
is deprecatedenv.note_versionchange()
is deprecatedsphinx.writers.latex.Table.caption_footnotetexts
is deprecatedsphinx.writers.latex.Table.header_footnotetexts
is deprecatedsphinx.writers.latex.LaTeXTranslator.footnotestack
is deprecatedsphinx.writers.latex.LaTeXTranslator.in_container_literal_block
is deprecatedsphinx.writers.latex.LaTeXTranslator.next_section_ids
is deprecatedsphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids
is deprecatedsphinx.writers.latex.LaTeXTranslator.restrict_footnote()
is deprecatedsphinx.writers.latex.LaTeXTranslator.unrestrict_footnote()
is deprecatedsphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids()
is deprecatedsphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids()
is deprecatedsphinx.writers.latex.LaTeXTranslator.check_latex_elements()
is deprecatedsphinx.writers.latex.LaTeXTranslator.bibitems
is deprecatedsphinx.writers.latex.LaTeXTranslator.hlsettingstack
is deprecatedsphinx.writers.latex.ExtBabel.get_shorthandoff()
is deprecatedsphinx.writers.html.HTMLTranslator.highlightlang
is deprecatedsphinx.writers.html.HTMLTranslator.highlightlang_base
is deprecatedsphinx.writers.html.HTMLTranslator.highlightlangopts
is deprecatedsphinx.writers.html.HTMLTranslator.highlightlinenothreshold
is deprecatedsphinx.writers.html5.HTMLTranslator.highlightlang
is deprecatedsphinx.writers.html5.HTMLTranslator.highlightlang_base
is deprecatedsphinx.writers.html5.HTMLTranslator.highlightlangopts
is deprecatedsphinx.writers.html5.HTMLTranslator.highlightlinenothreshold
is deprecatedsphinx.ext.mathbase
extension is deprecatedsphinx.ext.mathbase.math
node is deprecatedsphinx.ext.mathbase.displaymath
node is deprecatedsphinx.ext.mathbase.eqref
node is deprecatedsphinx.ext.mathbase.is_in_section_title()
is deprecatedsphinx.ext.mathbase.MathDomain
is deprecatedsphinx.ext.mathbase.MathDirective
is deprecatedsphinx.ext.mathbase.math_role
is deprecatedsphinx.ext.mathbase.setup_math()
is deprecatedsphinx.directives.other.VersionChanges
is deprecatedsphinx.highlighting.PygmentsBridge.unhighlight()
is deprecatedsphinx.ext.mathbase.get_node_equation_number()
is deprecatedsphinx.ext.mathbase.wrap_displaymath()
is deprecatedThe
trim_doctest_flags
argument ofsphinx.highlighting.PygmentsBridge
is deprecated
For more details, see deprecation APIs list
Features added¶
1.8.0b2
#5388: Ensure frozen object descriptions are reproducible
#5362: apidoc: Add
--tocfile
option to change the filename of ToC
1.8.0b1
Add :event:`config-inited` event
Add
sphinx.config.Any
to represent the config value accepts any type of value:confval:`source_suffix` allows a mapping fileext to file types
Add :confval:`author` as a configuration value
#2852: imgconverter: Support to convert GIF to PNG
sphinx-build
command supports i18n console outputAdd
app.add_message_catalog()
andsphinx.locale.get_translations()
to support translation for 3rd party extensionshelper function
warning()
for HTML themes is addedAdd
Domain.enumerable_nodes
to manage own enumerable nodes for domains (experimental)Add a new keyword argument
override
to Application APIsLaTeX: new key
'fvset'
for :confval:`latex_elements`. For XeLaTeX/LuaLaTeX its default setsfanvyvrb
to use normal, not small, fontsize in code-blocks (refs: #4793)Add :confval:`html_css_files` and :confval:`epub_css_files` for adding CSS files from configuration
Add :confval:`html_js_files` for adding JS files from configuration
#4834: Ensure set object descriptions are reproducible.
#4828: Allow to override :confval:`numfig_format` partially. Full definition is not needed.
Improve warning messages during including (refs: #4818)
LaTeX: separate customizability of
guilabel
andmenuselection
(refs: #4830)Add
Config.read()
classmethod to create a new config object from configuration file#4866: Wrap graphviz diagrams in
<div>
tagviewcode: Add :event:`viewcode-find-source` and :event:`viewcode-follow-imported` to load source code without loading
#4785: napoleon: Add strings to translation file for localisation
#4927: Display a warning when invalid values are passed to linenothreshold option of highlight directive
C++:
Add a
cpp:texpr
role as a sibling tocpp:expr
.Add support for unions.
#3593, #2683: add support for anonymous entities using names staring with
@
.#5147: add support for (most) character literals.
Cross-referencing entities inside primary templates is supported, and now properly documented.
#1552: add new cross-referencing format for
cpp:any
andcpp:func
roles, for referencing specific function overloads.
#3606: MathJax should be loaded with async attribute
html: Output
canonical_url
metadata if :confval:`html_baseurl` set (refs: #4193)#5029: autosummary: expose
inherited_members
to template#3784: mathjax: Add :confval:`mathjax_options` to give options to script tag for mathjax
#726, #969: mathjax: Add :confval:`mathjax_config` to give in-line configurations for mathjax
#4362: latex: Don’t overwrite .tex file if document not changed
#1431: latex: Add alphanumeric enumerated list support
Add :confval:`latex_use_xindy` for UTF-8 savvy indexing, defaults to
True
if :confval:`latex_engine` is'xelatex'
or'lualatex'
. (refs: #5134, #5192, #5212)#4976:
SphinxLoggerAdapter.info()
now supportslocation
parameter#5122: setuptools: support nitpicky option
#2820: autoclass directive supports nested class
Add
app.add_html_math_renderer()
to register a math renderer for HTMLApply :confval:`trim_doctest_flags` to all builders (cf. text, manpages)
#5140: linkcheck: Add better Accept header to HTTP client
#4614: sphinx-build: Add
--keep-going
option to show all warningsAdd
math:numref
role to refer equations (Same aseq
)quickstart: epub builder is enabled by default
#5246: Add :confval:`singlehtml_sidebars` to configure sidebars for singlehtml builder
#5273: doctest: Skip doctest conditionally
#5306: autodoc: emit a warning for invalid typehints
#4075, #5215: autodoc: Add :confval:`autodoc_default_options` which accepts option values as dict
Bugs fixed¶
1.8.0b2
html: search box overrides to other elements if scrolled
i18n: warnings for translation catalogs have wrong line numbers (refs: #5321)
#5325: latex: cross references has been broken by multiply labeled objects
C++, fixes for symbol addition and lookup. Lookup should no longer break in partial builds. See also #5337.
#5348: download reference to remote file is not displayed
#5282: html theme:
pygments_style
of theme was overridden byconf.py
by default#4379: toctree shows confusing warning when document is excluded
#2401: autodoc:
:members:
causes:special-members:
not to be shownautodoc: ImportError is replaced by AttributeError for deeper module
#2720, #4034: Incorrect links with
:download:
, duplicate names, and parallel builds#5290: autodoc: failed to analyze source code in egg package
#5399: Sphinx crashes if unknown po file exists
1.8.0b1
i18n: message catalogs were reset on each initialization
#4850: latex: footnote inside footnote was not rendered
#4945: i18n: fix lang_COUNTRY not fallback correctly for IndexBuilder. Thanks to Shengjing Zhu.
#4983: productionlist directive generates invalid IDs for the tokens
#5132: lualatex: PDF build fails if indexed word starts with Unicode character
#5133: latex: index headings “Symbols” and “Numbers” not internationalized
#5114: sphinx-build: Handle errors on scanning documents
epub: spine has been broken when “self” is listed on toctree (refs: #4611)
#344: autosummary does not understand docstring of module level attributes
#5191: C++, prevent nested declarations in functions to avoid lookup problems.
#5126: C++, add missing isPack method for certain template parameter types.
#5187: C++, parse attributes on declarators as well.
C++, parse delete expressions and basic new expressions as well.
#5002: graphviz: SVGs do not adapt to the column width
Documentation¶
1.8.0b1
#5083: Fix wrong make.bat option for internationalization.
#5115: napoleon: add admonitions added by #4613 to the docs.
Release 1.7.9 (released Sep 05, 2018)¶
Features added¶
#5359: Make generated texinfo files reproducible by sorting the anchors
Bugs fixed¶
#5361: crashed on incremental build if document uses include directive
Release 1.7.8 (released Aug 29, 2018)¶
Incompatible changes¶
The type of
env.included
has been changed to dict of set
Bugs fixed¶
#5320: intersphinx: crashed if invalid url given
#5326: manpage: crashed when invalid docname is specified as
man_pages
#5322: autodoc:
Any
typehint causes formatting error#5327: “document isn’t included in any toctree” warning on rebuild with generated files
#5335: quickstart: escape sequence has been displayed with MacPorts’ python
Release 1.7.7 (released Aug 19, 2018)¶
Bugs fixed¶
#5198: document not in toctree warning when including files only for parallel builds
LaTeX: reduce “Token not allowed in a PDF string” hyperref warnings in latex console output (refs: #5236)
LaTeX: suppress “remreset Warning: The remreset package is obsolete” in latex console output with recent LaTeX (refs: #5237)
#5234: PDF output: usage of PAPER environment variable is broken since Sphinx 1.5
LaTeX: fix the :confval:`latex_engine` documentation regarding Latin Modern font with XeLaTeX/LuaLateX (refs: #5251)
#5280: autodoc: Fix wrong type annotations for complex typing
autodoc: Optional types are wrongly rendered
#5291: autodoc crashed by ForwardRef types
#5211: autodoc: No docs generated for functools.partial functions
#5306: autodoc:
getargspec()
raises NameError for invalid typehints#5298: imgmath: math_number_all causes equations to have two numbers in html
#5294: sphinx-quickstart blank prompts in PowerShell
Release 1.7.6 (released Jul 17, 2018)¶
Bugs fixed¶
#5037: LaTeX
\sphinxupquote{}
breaks in Russiansphinx.testing uses deprecated pytest API;
Node.get_marker(name)
#5016: crashed when recommonmark.AutoStrictify is enabled
#5022: latex: crashed with docutils package provided by Debian/Ubuntu
#5009: latex: a label for table is vanished if table does not have a caption
#5048: crashed with numbered toctree
#2410: C, render empty argument lists for macros.
C++, fix lookup of full template specializations with no template arguments.
#4667: C++, fix assertion on missing references in global scope when using intersphinx. Thanks to Alan M. Carroll.
#5019: autodoc: crashed by Form Feed Character
#5032: autodoc: loses the first staticmethod parameter for old styled classes
#5036: quickstart: Typing Ctrl-U clears the whole of line
#5066: html: “relations” sidebar is not shown by default
#5091: latex: curly braces in index entries are not handled correctly
#5070: epub: Wrong internal href fragment links
#5104: apidoc: Interface of
sphinx.apidoc:main()
has changed#4272: PDF builds of French projects have issues with XeTeX
#5076: napoleon raises RuntimeError with python 3.7
#5125: sphinx-build: Interface of
sphinx:main()
has changedsphinx-build:
sphinx.cmd.build.main()
referssys.argv
instead of given argument#5146: autosummary: warning is emitted when the first line of docstring ends with literal notation
autosummary: warnings of autosummary indicates wrong location (refs: #5146)
#5143: autodoc: crashed on inspecting dict like object which does not support sorting
#5139: autodoc: Enum argument missing if it shares value with another
#4946: py domain: rtype field could not handle “None” as a type
#5176: LaTeX: indexing of terms containing
@
,!
, or"
fails#5161: html: crashes if copying static files are failed
#5167: autodoc: Fix formatting type annotations for tuples with more than two arguments
#3329: i18n: crashed by auto-symbol footnote references
#5158: autosummary: module summary has been broken when it starts with heading
Release 1.7.5 (released May 29, 2018)¶
Bugs fixed¶
#4924: html search: Upper characters problem in any other languages
#4932: apidoc: some subpackage is ignored if sibling subpackage contains a module starting with underscore
#4863, #4938, #4939: i18n doesn’t handle correctly node.title as used for contents, topic, admonition, table and section.
#4913: i18n: literal blocks in bullet list are not translated
#4962: C++, raised TypeError on duplicate declaration.
#4825: C++, properly parse expr roles and give better error messages when (escaped) line breaks are present.
C++, properly use
desc_addname
nodes for prefixes of names.C++, parse pack expansions in function calls.
#4915, #4916: links on search page are broken when using dirhtml builder
#4969: autodoc: constructor method should not have return annotation
latex: deeply nested enumerated list which is beginning with non-1 causes LaTeX engine crashed
#4978: latex: shorthandoff is not set up for Brazil locale
#4928: i18n: Ignore dot-directories like .git/ in LC_MESSAGES/
#4946: py domain: type field could not handle “None” as a type
#4979: latex: Incorrect escaping of curly braces in index entries
#4956: autodoc: Failed to extract document from a subclass of the class on mocked module
#4973: latex: glossary directive adds whitespace to each item
#4980: latex: Explicit labels on code blocks are duplicated
#4919: node.asdom() crashes if toctree has :numbered: option
#4914: autodoc: Parsing error when using dataclasses without default values
#4931: autodoc: crashed when handler for autodoc-skip-member raises an error
#4931: autodoc: crashed when subclass of mocked class are processed by napoleon module
#5007: sphinx-build crashes when error log contains a “%” character
Release 1.7.4 (released Apr 25, 2018)¶
Bugs fixed¶
#4885, #4887: domains: Crashed with duplicated objects
#4889: latex: sphinx.writers.latex causes recursive import
Release 1.7.3 (released Apr 23, 2018)¶
Bugs fixed¶
#4769: autodoc loses the first staticmethod parameter
#4790: autosummary: too wide two column tables in PDF builds
#4795: Latex customization via
_templates/longtable.tex_t
is broken#4789: imgconverter: confused by convert.exe of Windows
#4783: On windows, Sphinx crashed when drives of srcdir and outdir are different
#4812: autodoc ignores type annotated variables
#4817: wrong URLs on warning messages
#4784: latex: :confval:`latex_show_urls` assigns incorrect footnote numbers if hyperlinks exists inside substitutions
#4837: latex with class memoir Error: Font command
\sf
is not supported#4803: latex: too slow in proportion to number of auto numbered footnotes
#4838: htmlhelp: The entries in .hhp file is not ordered
toctree directive tries to glob for URL having query_string
#4871: html search: Upper characters problem in German
#4717: latex: Compilation for German docs failed with LuaLaTeX and XeLaTeX
#4459: duplicated labels detector does not work well in parallel build
#4878: Crashed with extension which returns invalid metadata
Release 1.7.2 (released Mar 21, 2018)¶
Incompatible changes¶
#4520: apidoc: folders with an empty __init__.py are no longer excluded from TOC
Bugs fixed¶
#4669: sphinx.build_main and sphinx.make_main throw NameError
#4685: autosummary emits meaningless warnings
autodoc: crashed when invalid options given
pydomain: always strip parenthesis if empty (refs: #1042)
#4689: autosummary: unexpectedly strips docstrings containing “i.e.”
#4701: viewcode: Misplaced
<div>
in viewcode html output#4444: Don’t require numfig to use :numref: on sections
#4727: Option clash for package textcomp
#4725: Sphinx does not work with python 3.5.0 and 3.5.1
#4716: Generation PDF file with TexLive on Windows, file not found error
#4574: vertical space before equation in latex
#4720: message when an image is mismatched for builder is not clear
#4655, #4684: Incomplete localization strings in Polish and Chinese
#2286: Sphinx crashes when error is happens in rendering HTML pages
#4688: Error to download remote images having long URL
#4754: sphinx/pycode/__init__.py raises AttributeError
#1435: qthelp builder should htmlescape keywords
epub: Fix docTitle elements of toc.ncx is not escaped
#4520: apidoc: Subpackage not in toc (introduced in 1.6.6) now fixed
#4767: html: search highlighting breaks mathjax equations
Release 1.7.1 (released Feb 23, 2018)¶
Deprecated¶
#4623:
sphinx.build_main()
is deprecated.autosummary: The interface of
sphinx.ext.autosummary.get_documenter()
has been changed (Since 1.7.0)#4664:
sphinx.ext.intersphinx.debug()
is deprecated.
For more details, see deprecation APIs list
Bugs fixed¶
#4608: epub: Invalid meta tag is generated
#4260: autodoc: keyword only argument separator is not disappeared if it is appeared at top of the argument list
#4622: epub: :confval:`epub_scheme` does not effect to content.opf
#4627: graphviz: Fit graphviz images to page
#4617: quickstart: PROJECT_DIR argument is required
#4623: sphinx.build_main no longer exists in 1.7.0
#4615: The argument of
sphinx.build
has been changed in 1.7.0autosummary: The interface of
sphinx.ext.autosummary.get_documenter()
has been changed#4630: Have order on msgids in sphinx.pot deterministic
#4563: autosummary: Incorrect end of line punctuation detection
#4577: Enumerated sublists with explicit start with wrong number
#4641: A external link in TOC cannot contain “?” with
:glob:
optionC++, add missing parsing of explicit casts and typeid in expression parsing.
C++, add missing parsing of
this
in expression parsing.#4655: Fix incomplete localization strings in Polish
#4653: Fix error reporting for parameterless ImportErrors
#4664: Reading objects.inv fails again
#4662:
any
refs withterm
targets crash when an ambiguity is encountered
Release 1.7.0 (released Feb 12, 2018)¶
Incompatible changes¶
1.7.0b1
#3668: The arguments has changed of main functions for each command
#3893: Unknown html_theme_options throw warnings instead of errors
#3927: Python parameter/variable types should match classes, not all objects
#3962: sphinx-apidoc now recognizes given directory as an implicit namespace package when
--implicit-namespaces
option given, not subdirectories of given directory.#3929: apidoc: Move sphinx.apidoc to sphinx.ext.apidoc
#4226: apidoc: Generate new style makefile (make-mode)
#4274: sphinx-build returns 2 as an exit code on argument error
#4389: output directory will be created after loading extensions
autodoc does not generate warnings messages to the generated document even if :confval:`keep_warnings` is True. They are only emitted to stderr.
shebang line is removed from generated conf.py
#2557: autodoc: :confval:`autodoc_mock_imports` only mocks specified modules with their descendants. It does not mock their ancestors. If you want to mock them, please specify the name of ancestors explicitly.
#3620: html theme: move DOCUMENTATION_OPTIONS to independent JavaScript file (refs: #4295)
#4246: Limit width of text body for all themes. Configurable via theme options
body_min_width
andbody_max_width
.#4771: apidoc: The
exclude_patterns
arguments are ignored if they are placed just after command line options
1.7.0b2
#4467: html theme: Rename
csss
block tocss
Deprecated¶
1.7.0b1
using a string value for :confval:`html_sidebars` is deprecated and only list values will be accepted at 2.0.
format_annotation()
andformatargspec()
is deprecated. Please usesphinx.util.inspect.Signature
instead.sphinx.ext.autodoc.AutodocReporter
is replaced bysphinx.util.docutils. switch_source_input()
and now deprecated. It will be removed in Sphinx-2.0.sphinx.ext.autodoc.add_documenter()
andAutoDirective._register
is now deprecated. Please useapp.add_autodocumenter()
instead.AutoDirective._special_attrgetters
is now deprecated. Please useapp.add_autodoc_attrgetter()
instead.
Features added¶
1.7.0b1
C++, handle
decltype(auto)
.#2406: C++, add proper parsing of expressions, including linking of identifiers.
C++, add a
cpp:expr
role for inserting inline C++ expressions or types.C++, support explicit member instantiations with shorthand
template
prefixC++, make function parameters linkable, like template params.
#3638: Allow to change a label of reference to equation using
math_eqref_format
Now :confval:`suppress_warnings` accepts following configurations:
ref.python
(ref: #3866)
#3872: Add latex key to configure literal blocks caption position in PDF output (refs #3792, #1723)
In case of missing docstring try to retrieve doc from base classes (ref: #3140)
#4023: Clarify error message when any role has more than one target.
#3973: epub: allow to override build date
#3972: epub: Sort manifest entries by filename
#4052: viewcode: Sort before highlighting module code
#1448: qthelp: Add new config value; :confval:`qthelp_namespace`
#4140: html themes: Make body tag inheritable
#4168: improve zh search with jieba
HTML themes can set up default sidebars through
theme.conf
#3160: html: Use
<kdb>
to represent:kbd:
role#4212: autosummary: catch all exceptions when importing modules
#4166: Add :confval:`math_numfig` for equation numbering by section (refs: #3991, #4080). Thanks to Oliver Jahn.
#4311: Let LaTeX obey :confval:`numfig_secnum_depth` for figures, tables, and code-blocks
#947: autodoc now supports ignore-module-all to ignore a module’s
__all__
#4332: Let LaTeX obey :confval:`math_numfig` for equation numbering
#4093: sphinx-build creates empty directories for unknown targets/builders
Add
top-classes
option for thesphinx.ext.inheritance_diagram
extension to limit the scope of inheritance graphs.#4183: doctest:
:pyversion:
option also follows PEP-440 specification#4235: html: Add :confval:`manpages_url` to make manpage roles to hyperlinks
#3570: autodoc: Do not display ‘typing.’ module for type hints
#4354: sphinx-build now emits finish message. Builders can modify it through
Builder.epilog
attribute#4245: html themes: Add
language
to javascript vars list#4079: html: Add
notranslate
class to each code-blocks, literals and maths to let Google Translate know they are not translatable#4137: doctest: doctest block is always highlighted as python console (pycon)
#4137: doctest: testcode block is always highlighted as python
#3998: text: Assign section numbers by default. You can control it using :confval:`text_add_secnumbers` and :confval:`text_secnumber_suffix`
1.7.0b2
#4271: sphinx-build supports an option called
-j auto
to adjust numbers of processes automatically.Napoleon: added option to specify custom section tags.
Features removed¶
1.7.0b1
Configuration variables
html_use_smartypants
latex_keep_old_macro_names
latex_elements[‘footer’]
utility methods of
sphinx.application.Sphinx
classbuildername (property)
_display_chunk()
old_status_iterator()
status_iterator()
_directive_helper()
utility methods of
sphinx.environment.BuildEnvironment
classcurrmodule (property)
currclass (property)
epub2 builder
prefix and colorfunc parameter for warn()
sphinx.util.compat
modulesphinx.util.nodes.process_only_nodes()
LaTeX environment
notice
, usesphinxadmonition
insteadLaTeX
\sphinxstylethead
, use\sphinxstyletheadfamily
C++, support of function concepts. Thanks to mickk-on-cpp.
Not used and previously not documented LaTeX macros
\shortversion
and\setshortversion
Bugs fixed¶
1.7.0b1
#3882: Update the order of files for HTMLHelp and QTHelp
#3962: sphinx-apidoc does not recognize implicit namespace packages correctly
#4094: C++, allow empty template argument lists.
C++, also hyperlink types in the name of declarations with qualified names.
C++, do not add index entries for declarations inside concepts.
C++, support the template disambiguator for dependent names.
#4314: For PDF ‘howto’ documents, numbering of code-blocks differs from the one of figures and tables
#4330: PDF ‘howto’ documents have an incoherent default LaTeX tocdepth counter setting
#4198: autosummary emits multiple ‘autodoc-process-docstring’ event. Thanks to Joel Nothman.
#4081: Warnings and errors colored the same when building
latex: Do not display ‘Release’ label if :confval:`release` is not set
1.7.0b2
#4415: autodoc classifies inherited classmethods as regular methods
#4415: autodoc classifies inherited staticmethods as regular methods
#4472: DOCUMENTATION_OPTIONS is not defined
#4491: autodoc: prefer _MockImporter over other importers in sys.meta_path
#4490: autodoc: type annotation is broken with python 3.7.0a4+
utils package is no longer installed
#3952: apidoc: module header is too escaped
#4275: Formats accepted by sphinx.util.i18n.format_date are limited
#4493: recommonmark raises AttributeError if AutoStructify enabled
#4209: intersphinx: In link title, “v” should be optional if target has no version
#4230: slowdown in writing pages with sphinx 1.6
#4522: epub: document is not rebuilt even if config changed
1.7.0b3
#4019: inheritance_diagram AttributeError stopping make process
#4531: autosummary: methods are not treated as attributes
#4538: autodoc:
sphinx.ext.autodoc.Options
has been moved#4539: autodoc emits warnings for partialmethods
#4223: doctest: failing tests reported in wrong file, at wrong line
i18n: message catalogs are not compiled if specific filenames are given for
sphinx-build
as arguments (refs: #4560)#4027: sphinx.ext.autosectionlabel now expects labels to be the same as they are in the raw source; no smart quotes, nothig fancy.
#4581: apidoc: Excluded modules still included
Testing¶
1.7.0b1
Add support for docutils 0.14
Add tests for the
sphinx.ext.inheritance_diagram
extension.
Release 1.6.7 (released Feb 04, 2018)¶
Bugs fixed¶
#1922: html search: Upper characters problem in French
#4412: Updated jQuery version from 3.1.0 to 3.2.1
#4438: math: math with labels with whitespace cause html error
#2437: make full reference for classes, aliased with “alias of”
#4434: pure numbers as link targets produce warning
#4477: Build fails after building specific files
#4449: apidoc: include “empty” packages that contain modules
#3917: citation labels are transformed to ellipsis
#4501: graphviz: epub3 validation error caused if graph is not clickable
#4514: graphviz: workaround for wrong map ID which graphviz generates
#4525: autosectionlabel does not support parallel build
#3953: Do not raise warning when there is a working intersphinx inventory
#4487: math: ValueError is raised on parallel build. Thanks to jschueller.
#2372: autosummary: invalid signatures are shown for type annotated functions
#3942: html: table is not aligned to center even if
:align: center
Release 1.6.6 (released Jan 08, 2018)¶
Features added¶
#4181: autodoc: Sort dictionary keys when possible
VerbatimHighlightColor
is a new LaTeX ‘sphinxsetup’ key (refs: #4285)Easier customizability of LaTeX macros involved in rendering of code-blocks
Show traceback if conf.py raises an exception (refs: #4369)
Add :confval:`smartquotes` to disable smart quotes through
conf.py
(refs: #3967)Add :confval:`smartquotes_action` and :confval:`smartquotes_excludes` (refs: #4142, #4357)
Bugs fixed¶
#4334: sphinx-apidoc: Don’t generate references to non-existing files in TOC
#4206: latex: reST label between paragraphs loses paragraph break
#4231: html: Apply fixFirefoxAnchorBug only under Firefox
#4221: napoleon depends on autodoc, but users need to load it manually
#2298: automodule fails to document a class attribute
#4099: C++: properly link class reference to class from inside constructor
#4267: PDF build broken by Unicode U+2116 NUMERO SIGN character
#4249: PDF output: Pygments error highlighting increases line spacing in code blocks
#1238: Support
:emphasize-lines:
in PDF output#4279: Sphinx crashes with pickling error when run with multiple processes and remote image
#1421: Respect the quiet flag in sphinx-quickstart
#4281: Race conditions when creating output directory
#4315: For PDF ‘howto’ documents,
latex_toplevel_sectioning='part'
generates\chapter
commands#4214: Two todolist directives break sphinx-1.6.5
Fix links to external option docs with intersphinx (refs: #3769)
#4091: Private members not documented without :undoc-members:
Release 1.6.5 (released Oct 23, 2017)¶
Features added¶
#4107: Make searchtools.js compatible with pre-Sphinx1.5 templates
#4112: Don’t override the smart_quotes setting if it was already set
#4125: Display reference texts of original and translated passages on i18n warning message
#4147: Include the exception when logging PO/MO file read/write
Bugs fixed¶
#4085: Failed PDF build from image in parsed-literal using
:align:
option#4100: Remove debug print from autodoc extension
#3987: Changing theme from alabaster causes HTML build to fail
#4096: C++, don’t crash when using the wrong role type. Thanks to mitya57.
#4070, #4111: crashes when the warning message contains format strings (again)
#4108: Search word highlighting breaks SVG images
#3692: Unable to build HTML if writing .buildinfo failed
#4152: HTML writer crashes if a field list is placed on top of the document
#4063: Sphinx crashes when labeling directive
.. todolist::
#4134: [doc]
docutils.conf
is not documented explicitly#4169: Chinese language doesn’t trigger Chinese search automatically
#1020: ext.todo todolist not linking to the page in pdflatex
#3965: New quickstart generates wrong SPHINXBUILD in Makefile
#3739:
:module:
option is ignored at content of pyobjects#4149: Documentation: Help choosing :confval:`latex_engine`
#4090: [doc] :confval:`latex_additional_files` with extra LaTeX macros should not use
.tex
extensionFailed to convert reST parser error to warning (refs: #4132)
Release 1.6.4 (released Sep 26, 2017)¶
Features added¶
#3926: Add
autodoc_warningiserror
to suppress the behavior of-W
option during importing target modules on autodoc
Bugs fixed¶
#3924: docname lost after dynamically parsing RST in extension
#3946: Typo in sphinx.sty (this was a bug with no effect in default context)
- pep
and :rfc: does not supports
default-role
directive (refs: #3960)
#3960: default_role = ‘guilabel’ not functioning
Missing
texinputs_win/Makefile
to be used in latexpdf builder on windows.#4026: nature: Fix macOS Safari scrollbar color
#3877: Fix for C++ multiline signatures.
#4006: Fix crash on parallel build
#3969: private instance attributes causes AttributeError
#4041: C++, remove extra name linking in function pointers.
#4038: C, add missing documentation of
member
role.#4044: An empty multicolumn cell causes extra row height in PDF output
#4049: Fix typo in output of sphinx-build -h
#4062: hashlib.sha1() must take bytes, not unicode on Python 3
Avoid indent after index entries in latex (refs: #4066)
#4070: crashes when the warning message contains format strings
#4067: Return non-zero exit status when make subprocess fails
#4055: graphviz: the :align: option does not work for SVG output
#4055: graphviz: the :align: center option does not work for latex output
#4051:
warn()
function for HTML theme outputs ‘None’ string
Release 1.6.3 (released Jul 02, 2017)¶
Features added¶
latex: hint that code-block continues on next page (refs: #3764, #3792)
Bugs fixed¶
#3821: Failed to import sphinx.util.compat with docutils-0.14rc1
#3829: sphinx-quickstart template is incomplete regarding use of alabaster
#3772: ‘str object’ has no attribute ‘filename’
Emit wrong warnings if citation label includes hyphens (refs: #3565)
#3858: Some warnings are not colored when using –color option
#3775: Remove unwanted whitespace in default template
#3835: sphinx.ext.imgmath fails to convert SVG images if project directory name contains spaces
#3850: Fix color handling in make mode’s help command
#3865: use of self.env.warn in sphinx extension fails
#3824: production lists apply smart quotes transform since Sphinx 1.6.1
latex: fix
\sphinxbfcode
swallows initial space of argument#3878: Quotes in auto-documented class attributes should be straight quotes in PDF output
#3881: LaTeX figure floated to next page sometimes leaves extra vertical whitespace
#3885: duplicated footnotes raises IndexError
#3873: Failure of deprecation warning mechanism of
sphinx.util.compat.Directive
#3874: Bogus warnings for “citation not referenced” for cross-file citations
#3860: Don’t download images when builders not supported images
#3860: Remote image URIs without filename break builders not supported remote images
#3833: command line messages are translated unintentionally with
language
setting.#3840: make checking
epub_uid
strict#3851, #3706: Fix about box drawing characters for PDF output
#3900: autosummary could not find methods
#3902: Emit error if
latex_documents
contains non-unicode string in py2
Release 1.6.2 (released May 28, 2017)¶
Incompatible changes¶
#3789: Do not require typing module for python>=3.5
Bugs fixed¶
#3754: HTML builder crashes if HTML theme appends own stylesheets
#3756: epub: Entity ‘mdash’ not defined
#3758: Sphinx crashed if logs are emitted in conf.py
#3755: incorrectly warns about dedent with literalinclude
#3742: RTD PDF builds of Sphinx own docs are missing an index entry in the bookmarks and table of contents. This is rtfd/readthedocs.org#2857 issue, a workaround is obtained using some extra LaTeX code in Sphinx’s own
conf.py
#3770: Build fails when a “code-block” has the option emphasize-lines and the number indicated is higher than the number of lines
#3774: Incremental HTML building broken when using citations
#3763: got epubcheck validations error if epub_cover is set
#3779: ‘ImportError’ in sphinx.ext.autodoc due to broken ‘sys.meta_path’. Thanks to Tatiana Tereshchenko.
#3796: env.resolve_references() crashes when non-document node given
#3803: Sphinx crashes with invalid PO files
#3791: PDF “continued on next page” for long tables isn’t internationalized
#3788: smartquotes emits warnings for unsupported languages
#3807: latex Makefile for
make latexpdf
is only for unixen#3781: double hyphens in option directive are compiled as endashes
#3817: latex builder raises AttributeError
Release 1.6.1 (released May 16, 2017)¶
Dependencies¶
1.6b1
(updated) latex output is tested with Ubuntu trusty’s texlive packages (Feb. 2014) and earlier tex installations may not be fully compliant, particularly regarding Unicode engines xelatex and lualatex
(added) latexmk is required for
make latexpdf
on GNU/Linux and Mac OS X (refs: #3082)
Incompatible changes¶
1.6b1
#1061, #2336, #3235: Now generation of autosummary doesn’t contain imported members by default. Thanks to Luc Saffre.
LaTeX
\includegraphics
command isn’t overloaded: only\sphinxincludegraphics
has the custom code to fit image to available width if oversized.The subclasses of
sphinx.domains.Index
should overridegenerate()
method. The default implementation raises NotImplementedErrorLaTeX positioned long tables horizontally centered, and short ones flushed left (no text flow around table.) The position now defaults to center in both cases, and it will obey Docutils 0.13
:align:
option (refs #3415, #3377)option directive also allows all punctuations for the option name (refs: #3366)
#3413: if
literalinclude
’s:start-after:
is used, make:lines:
relative (refs #3412)literalinclude
directive does not allow the combination of:diff:
option and other options (refs: #3416)LuaLaTeX engine uses
fontspec
like XeLaTeX. It is advisedlatex_engine = 'lualatex'
be used only on up-to-date TeX installs (refs #3070, #3466):confval:`latex_keep_old_macro_names` default value has been changed from
True
toFalse
. This means that some LaTeX macros for styling are by default defined only with\sphinx..
prefixed names. (refs: #3429)Footer “Continued on next page” of LaTeX longtable’s now not framed (refs: #3497)
#3529: The arguments of
BuildEnvironment.__init__
is changed#3082: Use latexmk for pdf (and dvi) targets (Unix-like platforms only)
#3558: Emit warnings if footnotes and citations are not referenced. The warnings can be suppressed by
suppress_warnings
.latex made available (non documented) colour macros from a file distributed with pdftex engine for Plain TeX. This is removed in order to provide better support for multiple TeX engines. Only interface from
color
orxcolor
packages should be used by extensions of Sphinx latex writer. (refs #3550)Builder.env
is not filled at instantiation#3594: LaTeX: single raw directive has been considered as block level element
#3639: If
html_experimental_html5_writer
is available, epub builder use it by default.Sphinx.add_source_parser()
raises an error if duplicated
1.6b2
#3345: Replace the custom smartypants code with Docutils’ smart_quotes. Thanks to Dmitry Shachnev, and to Günter Milde at Docutils.
1.6b3
LaTeX package
eqparbox
is not used and not loaded by Sphinx anymoreLaTeX package
multirow
is not used and not loaded by Sphinx anymoreAdd line numbers to citation data in std domain
1.6 final
LaTeX package
threeparttable
is not used and not loaded by Sphinx anymore (refs #3686, #3532, #3377)
Features removed¶
Configuration variables
epub3_contributor
epub3_description
epub3_page_progression_direction
html_translator_class
html_use_modindex
latex_font_size
latex_paper_size
latex_preamble
latex_use_modindex
latex_use_parts
termsep
nodedefindex.html template
LDML format support in
today
,today_fmt
andhtml_last_updated_fmt
:inline:
option for the directives of sphinx.ext.graphviz extensionsphinx.ext.pngmath extension
sphinx.util.compat.make_admonition()
Features added¶
1.6b1
#3136: Add
:name:
option to the directives insphinx.ext.graphviz
#2336: Add
imported_members
option tosphinx-autogen
command to document imported members.C++, add
:tparam-line-spec:
option to templated declarations. When specified, each template parameter will be rendered on a separate line.#3359: Allow sphinx.js in a user locale dir to override sphinx.js from Sphinx
#3303: Add
:pyversion:
option to the doctest directive.#3378: (latex) support for
:widths:
option of table directives (refs: #3379, #3381)#3402: Allow to suppress “download file not readable” warnings using :confval:`suppress_warnings`.
#3377: latex: Add support for Docutils 0.13
:align:
option for tables (but does not implement text flow around table).latex: footnotes from inside tables are hyperlinked (except from captions or headers) (refs: #3422)
Emit warning if over dedent has detected on
literalinclude
directive (refs: #3416)Use for LuaLaTeX same default settings as for XeLaTeX (i.e.
fontspec
andpolyglossia
). (refs: #3070, #3466)Make
'extraclassoptions'
key oflatex_elements
public (refs #3480)#3463: Add warning messages for required EPUB3 metadata. Add default value to
epub_description
to avoid warning like other settings.#3476: setuptools: Support multiple builders
latex: merged cells in LaTeX tables allow code-blocks, lists, blockquotes… as do normal cells (refs: #3435)
HTML builder uses experimental HTML5 writer if
html_experimental_html5_writer
is True and docutils 0.13 or later is installed.LaTeX macros to customize space before and after tables in PDF output (refs #3504)
#3348: Show decorators in literalinclude and viewcode directives
#3108: Show warning if :start-at: and other literalinclude options does not match to the text
#3609: Allow to suppress “duplicate citation” warnings using
suppress_warnings
#2803: Discovery of builders by entry point
#1764, #1676: Allow setting ‘rel’ and ‘title’ attributes for stylesheets
#3589: Support remote images on non-HTML builders
#3589: Support images in Data URI on non-HTML builders
#2961: improve :confval:`autodoc_mock_imports`. Now the config value only requires to declare the top-level modules that should be mocked. Thanks to Robin Jarry.
#3449: On py3, autodoc use inspect.signature for more accurate signature calculation. Thanks to Nathaniel J. Smith.
#3641: Epub theme supports HTML structures that are generated by HTML5 writer.
#3644 autodoc uses inspect instead of checking types. Thanks to Jeroen Demeyer.
Add a new extension;
sphinx.ext.imgconverter
. It converts images in the document to appropriate format for builderslatex: Use templates to render tables (refs #3389, 2a37b0e)
1.6b2
LATEXMKOPTS
variable for the Makefile in$BUILDDIR/latex
to pass options tolatexmk
when executingmake latexpdf
(refs #3695, #3720)Add a new event
env-check-consistency
to check consistency to extensionsAdd
Domain.check_consistency()
to check consistency
Bugs fixed¶
1.6b1
literalinclude
directive expands tabs after dedent-ing (refs: #3416)#1574: Paragraphs in table cell doesn’t work in Latex output
#3288: Table with merged headers not wrapping text
#3491: Inconsistent vertical space around table and longtable in PDF
#3506: Depart functions for all admonitions in HTML writer now properly pass
node
todepart_admonition
.#2693: Sphinx latex style file wrongly inhibits colours for section headings for latex+dvi(ps,pdf,pdfmx)
C++, properly look up
any
references.#3624: sphinx.ext.intersphinx couldn’t load inventories compressed with gzip
#3551: PDF information dictionary is lacking author and title data
#3351: intersphinx does not refers context like
py:module
,py:class
and so on.Fail to load template file if the parent template is archived
1.6b2
#3661: sphinx-build crashes on parallel build
#3669: gettext builder fails with “ValueError: substring not found”
#3660: Sphinx always depends on sphinxcontrib-websupport and its dependencies
#3472: smart quotes getting wrong in latex (at least with list of strings via autoattribute) (refs: #3345, #3666)
1.6b3
#3588: No compact (p tag) html output in the i18n document build even when :confval:`html_compact_lists` is True.
The
make latexpdf
from 1.6b1 (for GNU/Linux and Mac OS, usinglatexmk
) aborted earlier in case of LaTeX errors than was the case with 1.5 series, due to hard-coded usage of--halt-on-error
option (refs #3695)#3683: sphinx.websupport module is not provided by default
#3683: Failed to build document if builder.css_file.insert() is called
#3714: viewcode extension not taking
highlight_code='none'
in account#3698: Moving :doc: to std domain broke backwards compatibility
#3633: misdetect unreferenced citations
1.6 final
LaTeX tables do not allow multiple paragraphs in a header cell
LATEXOPTS is not passed over correctly to pdflatex since 1.6b3
#3532: Figure or literal block captions in cells of short tables cause havoc in PDF output
Fix: in PDF captions of tables are rendered differently whether table is of longtable class or not (refs #3686)
#3725: Todo looks different from note in LaTeX output
#3479: stub-columns have no effect in LaTeX output
#3738: Nonsensical code in theming.py
#3746: PDF builds fail with latexmk 4.48 or earlier due to undefined options
-pdfxe
and-pdflua
Deprecated¶
1.6b1
sphinx.util.compat.Directive
class is now deprecated. Please use insteaddocutils.parsers.rst.Directive
sphinx.util.compat.docutils_version
is now deprecated#2367:
Sphinx.warn()
,Sphinx.info()
and other logging methods are now deprecated. Please usesphinx.util.logging
(Logging API) instead.#3318:
notice
is now deprecated as LaTeX environment name and will be removed at Sphinx 1.7. Extension authors please usesphinxadmonition
instead (as Sphinx does since 1.5.)Sphinx.status_iterator()
andSphinx.old_status_iterator()
is now deprecated. Please usesphinx.util:status_iterator()
instead.Sphinx._directive_helper()
is deprecated. Please usesphinx.util.docutils.directive_helper()
instead.BuildEnvironment.set_warnfunc()
is now deprecatedFollowing methods of
BuildEnvironment
is now deprecated.BuildEnvironment.note_toctree()
BuildEnvironment.get_toc_for()
BuildEnvironment.get_toctree_for()
BuildEnvironment.create_index()
Please use
sphinx.environment.adapters
modules instead.latex package
footnote
is not loaded anymore by its bundled replacementfootnotehyper-sphinx
. The redefined macros keep the same names as in the original package.#3429: deprecate config setting
latex_keep_old_macro_names
. It will be removed at 1.7, and already its default value has changed fromTrue
toFalse
.#3221: epub2 builder is deprecated
#3254:
sphinx.websupport
is now separated into independent package;sphinxcontrib-websupport
.sphinx.websupport
will be removed in Sphinx-2.0.#3628:
sphinx_themes
entry_point is deprecated. Please usesphinx.html_themes
instead.
1.6b2
#3662:
builder.css_files
is deprecated. Please useadd_stylesheet()
API instead.
1.6 final
LaTeX
\sphinxstylethead
is deprecated at 1.6 and will be removed at 1.7. Please move customization into new macro\sphinxstyletheadfamily
.
Release 1.6 (unreleased)¶
not released (because of package script error)
Release 1.5.6 (released May 15, 2017)¶
Bugs fixed¶
#3614: Sphinx crashes with requests-2.5.0
#3618: autodoc crashes with tupled arguments
#3664: No space after the bullet in items of a latex list produced by Sphinx
#3657: EPUB builder crashes if a document starting with genindex exists
#3588: No compact (p tag) html output in the i18n document build even when :confval:`html_compact_lists` is True.
#3685: AttributeError when using 3rd party domains
#3702: LaTeX writer styles figure legends with a hard-coded
\small
#3708: LaTeX writer allows irc scheme
#3717: Stop enforcing that favicon’s must be .ico
#3731, #3732: Protect isenumclass predicate against non-class arguments
#3320: Warning about reference target not being found for container types
Misspelled ARCHIVEPREFIX in Makefile for latex build repertory
Release 1.5.5 (released Apr 03, 2017)¶
Bugs fixed¶
#3597: python domain raises UnboundLocalError if invalid name given
#3599: Move to new MathJax CDN
Release 1.5.4 (released Apr 02, 2017)¶
Features added¶
#3470: Make genindex support all kinds of letters, not only Latin ones
Bugs fixed¶
#3445: setting
'inputenc'
key to\\usepackage[utf8x]{inputenc}
leads to failed PDF buildEPUB file has duplicated
nav.xhtml
link incontent.opf
except first time build#3488: objects.inv has broken when
release
orversion
contain return code#2073, #3443, #3490: gettext builder that writes pot files unless the content are same without creation date. Thanks to Yoshiki Shibukawa.
#3487: intersphinx: failed to refer options
#3496: latex longtable’s last column may be much wider than its contents
#3507: wrong quotes in latex output for productionlist directive
#3533: Moving from Sphinx 1.3.1 to 1.5.3 breaks LaTeX compilation of links rendered as code
#2665, #2607: Link names in C++ docfields, and make it possible for other domains.
#3542: C++, fix parsing error of non-type template argument with template.
#3065, #3520: python domain fails to recognize nested class
#3575: Problems with pdflatex in a Turkish document built with sphinx has reappeared (refs #2997, #2397)
#3577: Fix intersphinx debug tool
A LaTeX command such as
\\large
inserted in the title items of :confval:`latex_documents` causes failed PDF build (refs #3551, #3567)
Release 1.5.3 (released Feb 26, 2017)¶
Features added¶
Support requests-2.0.0 (experimental) (refs: #3367)
(latex) PDF page margin dimensions may be customized (refs: #3387)
literalinclude
directive allows combination of:pyobject:
and:lines:
options (refs: #3416)#3400: make-mode doesn’t use subprocess on building docs
Bugs fixed¶
#3370: the caption of code-block is not picked up for translation
LaTeX: :confval:`release` is not escaped (refs: #3362)