Sphinx 2.1.0 (2019-06-02)

See also

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 command

  • math directive now supports :class: option

  • #6310: imgmath: let imgmath_use_preview work also with the SVG format for images rendering inline math

  • todo: todo directive now supports :name: option

  • Enable override via environment of SPHINXOPTS and SPHINXBUILD Makefile variables (refs: #6232, #6303)

  • #6287: autodoc: Unable to document bound instance methods exported as module functions

  • #6289: autodoc: 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 autodoc_typehints to suppress typehints from signature

  • #1063: autodoc: automodule directive now handles undocumented module level variables

  • #6212 autosummary: Add 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 to py:function directive

  • py 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 of production 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