NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI, #832 most downloaded on PyPI
Python documentation generator
Latest stable
9.2.0
Last release 26 days ago
21 Oct 2026
Release timing varies
gaps range from 9 days to 10 months
Nearly every release is documented
notes for 59 of the last 60 stable releases
1 version withdrawn
withdrawn after publishing
19 years old
243 releases · first in 2008
Drag across the ruler to compare, or tap a release to open it.
Nothing published for this version
Nothing published for this version
Release 2.4.5 (released Nov 18, 2021)
#9807: Restrict Docutils to 0.17.x or older
#7197: LaTeX: platex cause error to build image directive with target url
#7223: Sphinx builds has been slower since 2.4.0
#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
#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
#7120: html: crashed when on scaling SVG images which have float dimensions
#7126: autodoc: TypeError: 'getset_descriptor' object is not iterable
The decode argument of sphinx.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
#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: 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 if autodoc_typehints = "description" set. This is an experimental extension and it will be integrated into autodoc core in Sphinx 3.0
SphinxTranslator now calls visitor/departure method for super node class if visitor/departure method for original node class not found
#6418: Add new event: object-description-transform
py domain: py:data and py: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
#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 encoded 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: role
C++:
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
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Nothing published for this version
Release 2.3.1 (released Dec 22, 2019)
#6936: sphinx-autogen: raises AttributeError
#6742: end-before option of literalinclude 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 user_agent.
#6867: text: content of admonitions starts after a blank line
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
#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 latex_elements
#1331: Add new config variable: user_agent
#6000: LaTeX: have backslash also be an inline literal word wrap break character
#4186: LaTeX: Support upLaTeX as a new 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 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 gettext_last_translator and gettext_language_team to customize headers of POT file
#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: 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 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 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 considers 0 and 1 as a boolean value
Nothing published for this version
Nothing published for this version
Release 2.2.2 (released Dec 03, 2019)
#6803: For security reason of python, parallel mode is disabled on macOS and Python3.8+
#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
#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
apidoc: template files are renamed to .rst_t
html: Field lists will be styled by grid layout
sphinx.domains.math.MathDomain.add_equation()
sphinx.domains.math.MathDomain.get_next_equation_number()
The info and warn arguments of sphinx.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()
#5124: graphviz: :graphviz_dot: option is renamed to :layout:
#1464: html: emit a warning if html_static_path and html_extra_path directories are inside output directory
#6514: html: Add a label to search input for accessibility purposes
#5602: apidoc: Add --templatedir option
#6475: Add override argument to app.add_autodocumenter()
#6310: imgmath: let 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 intersphinx_mapping
#6419: sphinx-build: give reasons why rebuilt
py domain: duplicated warning does not point the location of source code
#6499: html: Sphinx never updates a copy of 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: autodoc_inherit_docstrings does not effect to __init__() and __new__()
#6574: autodoc: 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: 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
Nothing published for this version
Nothing published for this version
For more details, see deprecation APIs list .
#6497: custom lexers fails highlighting when syntax error
#6478, #6488: info field lists are incorrectly recognized
#6447: autodoc: Stop to generate document for undocumented module variables
#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
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.
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.
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
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 rst:directive:option directive to describe the option for directive
#6306: html: Add a label to search form for accessibility 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
#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)
Nothing published for this version
deprecation warnings are not emitted
LaTeX: some system labels are not translated
RemovedInSphinx30Warning is marked as pending
deprecation warnings are not emitted
sphinx.application.CONFIG_FILENAME
sphinx.builders.htmlhelp
!viewcode_import
#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
2.0.0b1
LaTeX builder now depends on TeX Live 2015 or above.
LaTeX builder (with 'pdflatex' 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 latex_elements; such (optional) support for Greek adds, for example on Ubuntu xenial, the texlive-lang-greek and (if default font set-up is not modified) cm-super(-minimal) as additional Sphinx LaTeX requirements.
LaTeX builder with latex_engine set to 'xelatex' or to 'lualatex' requires (by default) the FreeFont fonts, which in Ubuntu xenial are provided by package fonts-freefont-otf, and e.g. in Fedora 29 via package texlive-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
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 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 labels
LaTeX: for 'xelatex' and 'lualatex', use the FreeFont OpenType fonts as default choice (refs: #5645)
LaTeX: 'xelatex' and 'lualatex' now use \small in code-blocks (due to FreeMono character width) like 'pdflatex' already did (due to Courier character width). You may need to adjust this via 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 latex_elements for this to work (only if it is needed by the document, of course).
LaTeX: setting the language to 'en' triggered Sonny option of fncychap, now it is Bjarne to match case of no language specified. (refs: #5772)
#5770: doctest: Follow highlight_language on highlighting doctest block. As a result, they are highlighted as python3 by default.
The order of argument for HTMLTranslator, HTML5Translator and ManualPageTranslator are changed
LaTeX: 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 latex-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 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
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() and EpubBuilder.build_epub()
The arguments of Epub3Builder.build_navigation_doc()
The config variables
!html_experimental_html5_writer
The encoding argument of autodoc.Documenter.get_doc(), autodoc.DocstringSignatureMixin.get_doc(), autodoc.DocstringSignatureMixin._find_signature(), and autodoc.ClassDocumenter.get_doc() are deprecated.
The importer argument of sphinx.ext.autodoc.importer._MockModule
The nodetype argument of sphinx.search.WordCollector. is_meta_keywords()
The suffix argument of env.doc2path() is deprecated.
The string style base argument of env.doc2path() is deprecated.
The fallback to allow omitting the filename argument from an overridden IndexBuilder.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.
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 suppress_warnings
#5533: autodoc: autodoc_default_options supports member-order
#5394: autodoc: Display readable names in type annotations for mocked objects
#5459: autodoc: autodoc_default_options accepts True as a value
#1148: autodoc: Add autodecorator directive for decorators
#5635: autosummary: Add autosummary_mock_imports to mock external libraries on importing targets
#4018: htmlhelp: Add htmlhelp_file_suffix and 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 latex_engine (refs: #5645)
#5660: The versionadded, versionchanged and deprecated directives are now generated with their own specific CSS classes (added, changed and deprecated, respectively) in addition to the generic versionmodified 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 complement cpp: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 follows highlight or highlight_language
#4587: html: Add !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 html_baseurl set
#4261: autosectionlabel: restrict the labeled sections by new config value; autosectionlabel_maxdepth
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 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 latex_elements 'textgreek' key and/or 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-ligature
LaTeX: project name is not escaped if latex_documents omitted
LaTeX: authors are not shown if 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 for highlight directive was ignored
texinfo: make install-info causes syntax error
texinfo: 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 lost
AssertionError is raised when custom citation_reference node having classes attribute refers missing citation (refs: #6147)
#2155: Support code directive
C++, 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
2.0.0b1
Stop to use SPHINX_TEST_TEMPDIR envvar
2.0.0b2
Add a helper function: sphinx.testing.restructuredtext.parse()
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
sphinx.io.SphinxI18nReader.set_lineno_for_reporter() is deprecated
#9807: Restrict Docutils to 0.17.x or older
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 causes Use 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 for math 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
#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 failure
C++, 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
LaTeX: it is possible to insert custom material to appear on back of title page, see discussion of 'maketitle' key of latex_elements ('manual' docclass only)
#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
#5497: Do not include MathJax.js and jsmath.js unless it is really needed
#5471: Show appropriate deprecation warnings
#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
LaTeX \pagestyle commands have been moved to the LaTeX template. No changes in PDF, except possibly if \sphinxtableofcontents, which contained them, had been customized in conf.py. (refs: #5455)
#5418: Incorrect default path for sphinx-build -d/doctrees files
#5421: autodoc emits deprecation warning for !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
1.8.0b1
LaTeX: latex_use_xindy, if True (default for xelatex/lualatex), instructs make latexpdf to use xindy for general index. Make sure your LaTeX distribution includes it. (refs: #5134)
LaTeX: latexmk is required for make latexpdf on Windows
1.8.0b2
#5282: html theme: refer pygments_style settings of HTML themes preferentially
The URL of download files are changed
#5127: quickstart: Makefile and make.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 ext-metadata.
Sphinx expects source parser modules to have supported file formats as Parser.supported attribute
The default value of epub_author and epub_publisher are changed from 'unknown' to the value of author. This is same as a conf.py file sphinx-build generates.
The gettext_compact attribute is removed from document.settings object. Please use config.gettext_compact instead.
The processing order on reading phase is changed. smart_quotes, sphinx domains, 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 phase
docutils.conf in $HOME or /etc directories are ignored. Only docutils.conf from confdir is obeyed.
#789: :samp: role supports to escape curly braces with backslash
#4811: The files under html_static_path are excluded from source files.
latex: Use \sphinxcite for citation references instead \hyperref
The config value !viewcode_import is renamed to viewcode_follow_imported_members (refs: #4035)
#1857: latex: 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 use app.add_js_file() instead.
#5072: Save environment object also with only new documents
#5035: qthelp builder allows dashes in 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 variable
maketitle variable
tableofcontents variable
1.8.0b2
sphinx.io.SphinxI18nReader.set_lineno_for_reporter() is deprecated
sphinx.io.SphinxI18nReader.line is deprecated
sphinx.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
!source_parsers is deprecated
!autodoc_default_flags is deprecated
quickstart: --epub option becomes default, so it is deprecated
Drop function based directive support. For now, Sphinx only supports class based directives (see ~docutils.parsers.rst.Directive)
sphinx.util.docutils.directive_helper() is deprecated
sphinx.cmdline is deprecated
sphinx.make_mode is deprecated
sphinx.locale.l_() is deprecated
#2157: helper function warn() for HTML themes is deprecated
app.override_domain() is deprecated
app.add_stylesheet() is deprecated
app.add_javascript() is deprecated
app.import_object() is deprecated
app.add_source_parser() has changed; the suffix argument has been deprecated
sphinx.versioning.prepare() is deprecated
Config.__init__() has changed; the dirname, filename and tags argument has been deprecated
Config.check_types() is deprecated
Config.check_unicode() is deprecated
sphinx.application.CONFIG_FILENAME is deprecated
highlightlang directive is deprecated
BuildEnvironment.load() is deprecated
BuildEnvironment.loads() is deprecated
BuildEnvironment.frompickle() is deprecated
env.read_doc() is deprecated
env.update() is deprecated
env._read_serial() is deprecated
env._read_parallel() is deprecated
env.write_doctree() is deprecated
env._nitpick_ignore is deprecated
env.versionchanges is deprecated
env.dump() is deprecated
env.dumps() is deprecated
env.topickle() is deprecated
env.note_versionchange() is deprecated
sphinx.writers.latex.Table.caption_footnotetexts is deprecated
sphinx.writers.latex.Table.header_footnotetexts is deprecated
sphinx.writers.latex.LaTeXTranslator.footnotestack is deprecated
sphinx.writers.latex.LaTeXTranslator.in_container_literal_block is deprecated
sphinx.writers.latex.LaTeXTranslator.next_section_ids is deprecated
sphinx.writers.latex.LaTeXTranslator.next_hyperlink_ids is deprecated
sphinx.writers.latex.LaTeXTranslator.restrict_footnote() is deprecated
sphinx.writers.latex.LaTeXTranslator.unrestrict_footnote() is deprecated
sphinx.writers.latex.LaTeXTranslator.push_hyperlink_ids() is deprecated
sphinx.writers.latex.LaTeXTranslator.pop_hyperlink_ids() is deprecated
sphinx.writers.latex.LaTeXTranslator.check_latex_elements() is deprecated
sphinx.writers.latex.LaTeXTranslator.bibitems is deprecated
sphinx.writers.latex.LaTeXTranslator.hlsettingstack is deprecated
sphinx.writers.latex.ExtBabel.get_shorthandoff() is deprecated
sphinx.writers.html.HTMLTranslator.highlightlang is deprecated
sphinx.writers.html.HTMLTranslator.highlightlang_base is deprecated
sphinx.writers.html.HTMLTranslator.highlightlangopts is deprecated
sphinx.writers.html.HTMLTranslator.highlightlinenothreshold is deprecated
sphinx.writers.html5.HTMLTranslator.highlightlang is deprecated
sphinx.writers.html5.HTMLTranslator.highlightlang_base is deprecated
sphinx.writers.html5.HTMLTranslator.highlightlangopts is deprecated
sphinx.writers.html5.HTMLTranslator.highlightlinenothreshold is deprecated
sphinx.ext.mathbase extension is deprecated
sphinx.ext.mathbase.math node is deprecated
sphinx.ext.mathbase.displaymath node is deprecated
sphinx.ext.mathbase.eqref node is deprecated
sphinx.ext.mathbase.is_in_section_title() is deprecated
sphinx.ext.mathbase.MathDomain is deprecated
sphinx.ext.mathbase.MathDirective is deprecated
sphinx.ext.mathbase.math_role is deprecated
sphinx.ext.mathbase.setup_math() is deprecated
sphinx.directives.other.VersionChanges is deprecated
sphinx.highlighting.PygmentsBridge.unhighlight() is deprecated
sphinx.ext.mathbase.get_node_equation_number() is deprecated
sphinx.ext.mathbase.wrap_displaymath() is deprecated
The trim_doctest_flags argument of sphinx.highlighting.PygmentsBridge is deprecated
For more details, see deprecation APIs list.
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 config-inited event
Add sphinx.config.Any to represent the config value accepts any type of value
source_suffix allows a mapping fileext to file types
Add author as a configuration value
#2852: imgconverter: Support to convert GIF to PNG
sphinx-build command supports i18n console output
Add app.add_message_catalog() and sphinx.locale.get_translations() to support translation for 3rd party extensions
helper function warning() for HTML themes is added
Add Domain.enumerable_nodes to manage own enumerable nodes for domains (experimental)
Add a new keyword argument override to Application APIs
LaTeX: new key 'fvset' for latex_elements. For XeLaTeX/LuaLaTeX its default sets fanvyvrb to use normal, not small, fontsize in code-blocks (refs: #4793)
Add html_css_files and epub_css_files for adding CSS files from configuration
Add html_js_files for adding JS files from configuration
#4834: Ensure set object descriptions are reproducible.
#4828: Allow to override numfig_format partially. Full definition is not needed.
Improve warning messages during including (refs: #4818)
LaTeX: separate customizability of guilabel and menuselection (refs: #4830)
Add Config.read() classmethod to create a new config object from configuration file
#4866: Wrap graphviz diagrams in <div> tag
viewcode: Add viewcode-find-source and 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 to cpp: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 and cpp:func roles, for referencing specific function overloads.
#3606: MathJax should be loaded with async attribute
html: Output canonical_url metadata if html_baseurl set (refs: #4193)
#5029: autosummary: expose inherited_members to template
#3784: mathjax: Add mathjax_options to give options to script tag for mathjax
#726, #969: mathjax: Add 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 latex_use_xindy for UTF-8 savvy indexing, defaults to True if latex_engine is 'xelatex' or 'lualatex'. (refs: #5134, #5192, #5212)
#4976: SphinxLoggerAdapter.info() now supports location parameter
#5122: setuptools: support nitpicky option
#2820: autoclass directive supports nested class
Add app.add_html_math_renderer() to register a math renderer for HTML
Apply 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 warnings
Add math:numref role to refer equations (Same as eq)
quickstart: epub builder is enabled by default
#5246: Add 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 autodoc_default_options which accepts option values as dict
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 by conf.py by default
#4379: toctree shows confusing warning when document is excluded
#2401: autodoc: :members: causes :special-members: not to be shown
autodoc: 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
1.8.0b1
sphinx.ext.pngmath extension
1.8.0b1
#5083: Fix wrong make.bat option for internationalization.
#5115: napoleon: add admonitions added by #4613 to the docs.
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
sphinx.testing uses deprecated pytest API; Node.get_marker(name)
#5359: Make generated texinfo files reproducible by sorting the anchors
#5361: crashed on incremental build if document uses include directive
The type of env.included has been changed to dict of set
#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
#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 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
#5037: LaTeX \sphinxupquote{} breaks in Russian
sphinx.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 changed
sphinx-build: sphinx.cmd.build.main() refers sys.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
#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
#4885, #4887: domains: Crashed with duplicated objects
#4889: latex: sphinx.writers.latex causes recursive import
#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: 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
#4520: apidoc: folders with an empty __init__.py are no longer excluded from TOC
#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
#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.
#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: 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.0
autosummary: 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: option
C++, 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 with term targets crash when an ambiguity is encountered
1.7.0b1
Add packaging package
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 keep_warnings is True. They are only emitted to stderr.
shebang line is removed from generated conf.py
#2557: autodoc: 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 and body_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 to css
1.7.0b1
using a string value for html_sidebars is deprecated and only list values will be accepted at 2.0.
format_annotation() and formatargspec() is deprecated. Please use sphinx.util.inspect.Signature instead.
sphinx.ext.autodoc.AutodocReporter is replaced by sphinx.util.docutils. switch_source_input() and now deprecated. It will be removed in Sphinx 2.0.
sphinx.ext.autodoc.add_documenter() and AutoDirective._register is now deprecated. Please use app.add_autodocumenter() instead.
AutoDirective._special_attrgetters is now deprecated. Please use app.add_autodoc_attrgetter() instead.
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 prefix
C++, make function parameters linkable, like template params.
#3638: Allow to change a label of reference to equation using math_eqref_format
Now 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; 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 math_numfig for equation numbering by section (refs: #3991, #4080). Thanks to Oliver Jahn.
#4311: Let LaTeX obey 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 math_numfig for equation numbering
#4093: sphinx-build creates empty directories for unknown targets/builders
Add top-classes option for the sphinx.ext.inheritance_diagram extension to limit the scope of inheritance graphs.
#4183: doctest: :pyversion: option also follows PEP-440 specification
#4235: html: Add 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 text_add_secnumbers and 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.
1.7.0b1
Configuration variables
!html_use_smartypants
!latex_keep_old_macro_names
latex_elements['footer']
utility methods of sphinx.application.Sphinx class
buildername (property)
_display_chunk()
old_status_iterator()
status_iterator()
_directive_helper()
utility methods of sphinx.environment.BuildEnvironment class
currmodule (property)
currclass (property)
epub2 builder
prefix and colorfunc parameter for warn()
sphinx.util.compat module
sphinx.util.nodes.process_only_nodes()
LaTeX environment notice, use sphinxadmonition instead
LaTeX \sphinxstylethead, use \sphinxstyletheadfamily
C++, support of function concepts. Thanks to mickk-on-cpp.
Not used and previously not documented LaTeX macros \shortversion and \setshortversion
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 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
1.7.0b1
Add support for Docutils 0.14
Add tests for the sphinx.ext.inheritance_diagram extension.
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
sphinx.util.copy_static_entry() is now deprecated. Use sphinx.util.fileutil.copy_asset() instead.
#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 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
#3597: python domain raises UnboundLocalError if invalid name given
#3599: Move to new MathJax CDN
#3470: Make genindex support all kinds of letters, not only Latin ones
#3445: setting 'inputenc' key to \\usepackage[utf8x]{inputenc} leads to failed PDF build
EPUB file has duplicated nav.xhtml link in content.opf except first time build
#3488: objects.inv has broken when release or version 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 latex_documents causes failed PDF build (refs #3551, #3567)
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
#3370: the caption of code-block is not picked up for translation
LaTeX: release is not escaped (refs: #3362)
#3364: sphinx-quickstart prompts overflow on Console with 80 chars width
since 1.5, PDF's TOC and bookmarks lack an entry for general Index (refs: #3383)
#3392: 'releasename' in latex_elements is not working
#3356: Page layout for Japanese 'manual' docclass has a shorter text area
#3394: When 'pointsize' is not 10pt, Japanese 'manual' document gets wrong PDF page dimensions
#3399: quickstart: conf.py was not overwritten by template
#3366: option directive does not allow punctuations
#3410: return code in release breaks html search
#3427: autodoc: memory addresses are not stripped on Windows
#3428: xetex build tests fail due to fontspec v2.6 defining \strong
#3349: Result of IndexBuilder.load() is broken
#3450:   is appeared in EPUB docs
#3418: Search button is misaligned in nature and pyramid theme
#3421: Could not translate a caption of tables
#3552: linkcheck raises UnboundLocalError
Dependency requirement updates: requests 2.4.0 or above (refs: #3268, #3310)
#3241: emit latex warning if buggy titlesec (ref #3210)
#3194: Refer the $MAKE environment variable to determine make command
Emit warning for nested numbered toctrees (refs: #3142)
#978: intersphinx_mapping also allows a list as a parameter
#3340: (LaTeX) long lines in parsed-literal are wrapped like in code-block, inline math and footnotes are fully functional.
#3246: xapian search adapter crashes
#3253: In Py2 environment, building another locale with a non-captioned toctree produces None captions
#185: References to section title including raw node has broken
#3255: In Py3.4 environment, autodoc doesn't support documentation for attributes of Enum class correctly.
#3261: latex_use_parts makes Sphinx crash
The warning type misc.highlighting_failure does not work
#3294: add_latex_package() make crashes non-LaTeX builders
The caption of table are rendered as invalid HTML (refs: #3287)
#3268: Sphinx crashes with requests package from Debian jessie
#3284: Sphinx crashes on parallel build with an extension which raises unserializable exception
#3315: Bibliography crashes on latex build with docclass 'memoir'
#3328: Could not refer rubric implicitly
#3329: emit warnings if po file is invalid and can't read it. Also writing mo
#3337: Ugly rendering of definition list term's classifier
#3335: gettext does not extract field_name of a field in a field_list
#2952: C++, fix refs to operator() functions.
Fix Unicode super- and subscript digits in code-block and parsed-literal LaTeX output (ref #3342)
LaTeX writer: leave " character inside parsed-literal as is (ref #3341)
#3234: intersphinx failed for encoded inventories
#3158: too much space after captions in PDF output
#3317: An URL in parsed-literal contents gets wrongly rendered in PDF if with hyphen
LaTeX crash if the filename of an image inserted in parsed-literal via a substitution contains an hyphen (ref #3340)
LaTeX rendering of inserted footnotes in parsed-literal is wrong (ref #3340)
Inline math in parsed-literal is not rendered well by LaTeX (ref #3340)
#3308: Parsed-literals don't wrap very long lines with pdf builder (ref #3340)
#3295: Could not import extension sphinx.builders.linkcheck
#3285: autosummary: asterisks are escaped twice
LaTeX, pass dvipdfm option to geometry package for Japanese documents (ref #3363)
Fix parselinenos() could not parse left half open range (cf. "-4")
#3214: Allow to suppress "unknown mimetype" warnings from epub builder using suppress_warnings.
#3195: Can not build in parallel
#3198: AttributeError is raised when toctree has 'self'
#3211: Remove untranslated Sphinx locale catalogs (it was covered by untranslated it_IT)
#3212: HTML Builders crashes with Docutils 0.13
#3207: more latex problems with references inside parsed-literal directive (\DUrole)
#3205: sphinx.util.requests crashes with old pyOpenSSL (< 0.14)
#3220: KeyError when having a duplicate citation
#3200: LaTeX: xref inside desc_name not allowed
#3228: build_sphinx command crashes when missing dependency
#2469: Ignore updates of catalog files for gettext builder. Thanks to Hiroshi Ohkubo.
#3183: Randomized jump box order in generated index page.
1.5a1
latex, package fancybox is not any longer a dependency of sphinx.sty
Use 'locales' as a default value of locale_dirs
latex, package ifthen is not any longer a dependency of sphinx.sty
latex, style file does not modify fancyvrb's Verbatim (also available as OriginalVerbatim) but uses sphinxVerbatim for name of custom wrapper.
latex, package newfloat is not used (and not included) anymore (ref #2660; it was used since 1.3.4 and shipped with Sphinx since 1.4).
latex, literal blocks in tables do not use OriginalVerbatim but sphinxVerbatimintable which handles captions and wraps lines (ref #2704).
latex, replace pt by TeX equivalent bp if found in width or height attribute of an image.
latex, if width or height attribute of an image is given with no unit, use px rather than ignore it.
latex: Separate stylesheets of pygments to independent .sty file
#2454: The filename of sourcelink is now changed. The value of html_sourcelink_suffix will be appended to the original filename (like index.rst.txt).
sphinx.util.copy_static_entry() is now deprecated. Use sphinx.util.fileutil.copy_asset() instead.
sphinx.util.osutil.filecopy() skips copying if the file has not been changed (ref: #2510, #2753)
Internet Explorer 6-8, Opera 12.1x or Safari 5.1+ support is dropped because jQuery version is updated from 1.11.0 to 3.1.0 (ref: #2634, #2773)
QtHelpBuilder doesn't generate search page (ref: #2352)
QtHelpBuilder uses nonav theme instead of default one to improve readability.
latex: To provide good default settings to Japanese documents, Sphinx uses jreport and jsbook as docclass if language is ja.
sphinx-quickstart now allows a project version is empty
Fix :download: role on epub/qthelp builder. They ignore the role because they don't support it.
sphinx.ext.viewcode doesn't work on epub building by default. viewcode_enable_epub option
sphinx.ext.viewcode disabled on singlehtml builder.
Use make-mode of sphinx-quickstart by default. To disable this, use -M option
Fix genindex.html, Sphinx's document template, link address to itself to satisfy xhtml standard.
Use epub3 builder by default. And the old epub builder is renamed to epub2.
Fix epub and epub3 builders that contained links to genindex even if epub_use_index = False.
html_translator_class is now deprecated. Use ~sphinx.application.Sphinx.set_translator API instead.
Drop python 2.6 and 3.3 support
Drop epub3 builder's epub3_page_progression_direction option (use epub3_writing_mode).
#2877: Rename latex_elements['footer'] to latex_elements['atendofbody']
1.5a2
#2983: Rename epub3_description and epub3_contributor to epub_description and epub_contributor.
Remove themes/basic/defindex.html; no longer used
Sphinx does not ship anymore (but still uses) LaTeX style file fncychap
#2435: Slim down quickstarted conf.py
The sphinx.sty latex package does not load itself "hyperref", as this is done later in the preamble of the latex output via 'hyperref' key.
Sphinx does not ship anymore a custom modified LaTeX style file tabulary. The non-modified package is used.
#3057: By default, footnote marks in latex PDF output are not preceded by a space anymore, \sphinxBeforeFootnote allows user customization if needed.
LaTeX target requires that option hyperfootnotes of package hyperref be left unchanged to its default (i.e. true) (refs: #3022)
1.5 final
#2986: themes/basic/defindex.html is now deprecated
Emit warnings that will be deprecated in Sphinx 1.6 by default. Users can change the behavior by setting the environment variable PYTHONWARNINGS. Please refer when-deprecation-warnings-are-displayed.
#2454: new JavaScript variable SOURCELINK_SUFFIX is added
These features are removed in Sphinx 1.6:
LDML format support in i18n feature
sphinx.addnodes.termsep
Some functions and classes in sphinx.util.pycompat: zip_longest, product, all, any, next, open, class_types, base_exception, relpath, StringIO, BytesIO. Please use the standard library version instead;
If any deprecation warning like RemovedInSphinxXXXWarning are displayed, please refer when-deprecation-warnings-are-displayed.
1.5a1
#2951: Add --implicit-namespaces PEP-0420 support to apidoc.
Add :caption: option for sphinx.ext.inheritance_diagram.
#2471: Add config variable for default doctest flags.
Convert linkcheck builder to requests for better encoding handling
#2463, #2516: Add keywords of "meta" directive to search index
:maxdepth: option of toctree affects secnumdepth (ref: #2547)
#2575: Now sphinx.ext.graphviz allows :align: option
Show warnings if unknown key is specified to latex_elements
Show warnings if no domains match with primary_domain (ref: #2001)
C++, show warnings when the kind of role is misleading for the kind of target it refers to (e.g., using the class role for a function).
latex, writer abstracts more of text styling into customizable macros, e.g. the visit_emphasis will output \sphinxstyleemphasis rather than \emph (which may be in use elsewhere or in an added LaTeX package). See list at end of sphinx.sty (ref: #2686)
latex, public names for environments and parameters used by note, warning, and other admonition types, allowing full customizability from the 'preamble' key or an input file (ref: feature request #2674, #2685)
latex, better computes column widths of some tables (as a result, there will be slight changes as tables now correctly fill the line width; ref: #2708)
latex, sphinxVerbatim environment is more easily customizable (ref: #2704). In addition to already existing VerbatimColor and VerbatimBorderColor:
two lengths \sphinxverbatimsep and \sphinxverbatimborder,
booleans \ifsphinxverbatimwithframe and \ifsphinxverbatimwrapslines.
latex, captions for literal blocks inside tables are handled, and long code lines wrapped to fit table cell (ref: #2704)
#2597: Show warning messages as darkred
latex, allow image dimensions using px unit (default is 96px=1in)
Show warnings if invalid dimension units found
#2650: Add --pdb option to setup.py command
latex, make the use of \small for code listings customizable (ref #2721)
#2663: Add --warning-is-error option to setup.py command
Show warnings if deprecated latex options are used
Add sphinx.config.ENUM to check the config values is in candidates
math: Add hyperlink marker to each equations in HTML output
Add new theme nonav that doesn't include any navigation links. This is for any help generator like qthelp.
#2680: sphinx.ext.todo now emits warnings if todo_emit_warnings enabled. Also, it emits an additional event named todo-defined to handle the TODO entries in 3rd party extensions.
Python domain signature parser now uses the xref mixin for 'exceptions', allowing exception classes to be autolinked.
#2513: Add latex_engine to switch the LaTeX engine by conf.py
#2682: C++, basic support for attributes (C++11 style and GNU style). The new configuration variables 'cpp_id_attributes' and 'cpp_paren_attributes' can be used to introduce custom attributes.
#1958: C++, add configuration variable 'cpp_index_common_prefix' for removing prefixes from the index text of C++ objects.
C++, added concept directive. Thanks to mickk-on-cpp.
C++, added support for template introduction syntax. Thanks to mickk-on-cpp.
#2725: latex builder: allow to use user-defined template file (experimental)
apidoc now avoids invalidating cached files by not writing to files whose content doesn't change. This can lead to significant performance wins if apidoc is run frequently.
#2851: sphinx.ext.math emits missing-reference event if equation not found
#1210: eqref role now supports cross reference
#2892: Added -a (--append-syspath) option to sphinx-apidoc
#1604: epub3 builder: Obey font-related CSS when viewing in iBooks.
#646: option directive support '.' character as a part of options
Add document about kindlegen and fix document structure for it.
#2474: Add intersphinx_timeout option to sphinx.ext.intersphinx
#2926: EPUB3 builder supports vertical mode (epub3_writing_mode option)
#2695: build_sphinx subcommand for setuptools handles exceptions as same as sphinx-build does
#326: numref role can also refer sections
#2916: numref role can also refer caption as an its linktext
1.5a2
#3008: linkcheck builder ignores self-signed certificate URL
#3020: new 'geometry' key to latex_elements whose default uses LaTeX style file geometry.sty to set page layout
#2843: Add :start-at: and :end-at: options to literalinclude directive
#2527: Add :reversed: option to toctree directive
Add -t and -d option to sphinx-quickstart to support templating generated Sphinx project.
#3028: Add {path} and {basename} to the format of figure_language_filename
new 'hyperref' key in the latex_elements dictionary (ref #3030)
#3022: Allow code-blocks in footnotes for LaTeX PDF output
1.5b1
#2513: A better default settings for XeLaTeX
#3096: 'maxlistdepth' key to work around LaTeX list limitations
#3060: autodoc supports documentation for attributes of Enum class. Now autodoc render just the value of Enum attributes instead of Enum attribute representation.
Add --extensions to sphinx-quickstart to support enable arbitrary extensions from command line (ref: #2904)
#3104, #3122: 'sphinxsetup' for key=value styling of Sphinx LaTeX
#3071: Autodoc: Allow mocked module decorators to pass-through functions unchanged
#2495: linkcheck: Allow skipping anchor checking using linkcheck_anchors_ignore
#3083: let Unicode no-break space act like LaTeX ~ (fixed #3019)
#3116: allow word wrap in PDF output for inline literals (ref #3110)
#930: sphinx-apidoc allow wildcards for excluding paths. Thanks to Nick Coghlan.
#3121: add inlineliteralwraps option to control if inline literal word-wraps in latex
1.5 final
#3095: Add tls_verify and tls_cacerts to support self-signed HTTPS servers in linkcheck and intersphinx
#2215: make.bat generated by sphinx-quickstart can be called from another dir. Thanks to Timotheus Kampik.
#3185: Add new warning type misc.highlighting_failure
1.5a1
#2707: (latex) the column width is badly computed for tabular
#2799: Sphinx installs roles and directives automatically on importing sphinx module. Now Sphinx installs them on running application.
sphinx.ext.autodoc crashes if target code imports * from mock modules by autodoc_mock_imports.
#1953: Sphinx.add_node does not add handlers the translator installed by html_translator_class
#1797: text builder inserts blank line on top
#2894: quickstart main() doesn't use argv argument
#2874: gettext builder could not extract all text under the only directives
#2485: autosummary crashes with multiple source_suffix values
#1734: Could not translate the caption of toctree directive
Could not translate the content of meta directive (ref: #1734)
#2550: external links are opened in help viewer
#2687: Running Sphinx multiple times produces 'already registered' warnings
1.5a2
#2810: Problems with pdflatex in an Italian document
Use latex_elements.papersize to specify papersize of LaTeX in Makefile
#2988: linkcheck: retry with GET request if denied HEAD request
#2990: linkcheck raises "Can't convert 'bytes' object to str implicitly" error if linkcheck_anchors enabled
#3004: Invalid link types "top" and "up" are used
#3009: Bad rendering of parsed-literals in LaTeX since Sphinx 1.4.4
#3000: option directive generates invalid HTML anchors
#2984: Invalid HTML has been generated if html_split_index enabled
#2986: themes/basic/defindex.html should be changed for html5 friendly
#2987: Invalid HTML has been generated if multiple IDs are assigned to a list
#2891: HTML search does not provide all the results
#1986: Title in PDF Output
#147: Problem with latex chapter style
#3018: LaTeX problem with page layout dimensions and chapter titles
Fix an issue with \pysigline in LaTeX style file (ref #3023)
#3038: sphinx.ext.math* raises TypeError if labels are duplicated
#3031: incompatibility with LaTeX package tocloft
#3003: literal blocks in footnotes are not supported by Latex
#3047: spacing before footnote in pdf output is not coherent and allows breaks
#3045: HTML search index creator should ignore "raw" content if now html
#3039: English stemmer returns wrong word if the word is capitalized
Fix make-mode Makefile template (ref #3056, #2936)
1.5b1
#2432: Fix unwanted * between varargs and keyword only args. Thanks to Alex Grönholm.
#3062: Failed to build PDF using 1.5a2 (undefined \hypersetup for Japanese documents since PR#3030)
Better rendering of multiline signatures in html.
#777: LaTeX output "too deeply nested" (ref #3096)
Let LaTeX image inclusion obey scale before textwidth fit (ref #2865, #3059)
#3019: LaTeX fails on description of C function with arguments (ref #3083)
fix latex inline literals where < > - gobbled a space
1.5 final
#3069: Even if 'babel' key is set to empty string, LaTeX output contains one \addto\captions...
#3123: user 'babel' key setting is not obeyed anymore
#3155: Fix JavaScript for html_sourcelink_suffix fails with IE and Opera
#3085: keep current directory after breaking build documentation. Thanks to Timotheus Kampik.
#3181: pLaTeX crashes with a section contains endash
#3180: latex: add stretch/shrink between successive singleline or multipleline cpp signatures (ref #3072)
#3128: globing images does not support .svgz file
#3015: fix a broken test on Windows.
#1843: Fix documentation of descriptor classes that have a custom metaclass. Thanks to Erik Bray.
#3190: util.split_docinfo fails to parse multi-line field bodies
#3024, #3037: In Python3, application.Sphinx._log crushed when the log message cannot be encoded into console encoding.
To simplify, Sphinx uses external mock package even if unittest.mock exists.
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
One column per quarter.