search

limdauto / drf_openapi

[DEPRECATED] Beautiful Django Rest Framework API documentation autogeneration through OpenAPI standard
https://drf-openapi.readthedocs.io/en/latest/
MIT License
190 stars 39 forks source link

Update sphinx to 3.0.0 #319

Closed pyup-bot closed 4 years ago

pyup-bot commented 4 years ago

This PR updates Sphinx from 1.6.4 to 3.0.0.

Changelog ### 3.0.0 ``` * 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 from ``index`` 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 ``` ### 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 of ``html_link_suffix`` in search results * 7297: html theme: ``bizstyle`` does not support ``sidebarwidth`` * 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 ``` ### 2.4.4 ``` ===================================== Bugs fixed ---------- * 7197: LaTeX: platex cause error to build image directive with target url * 7223: Sphinx builds has been slower since 2.4.0 ``` ### 2.4.3 ``` ===================================== 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 ``` ### 2.4.2 ``` ===================================== 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 ``` ### 2.4.1 ``` ===================================== Bugs fixed ---------- * 7120: html: crashed when on scaling SVG images which have float dimentions * 7126: autodoc: TypeError: 'getset_descriptor' object is not iterable ``` ### 2.4.0 ``` ===================================== Deprecated ---------- * 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`` 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 <https://github.com/python/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: :event:`object-description-transform` * py domain: :rst:dir:`py:data` and :rst:dir:`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 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:`` 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 ``` ### 2.3.1 ``` ===================================== Bugs fixed ---------- * 6936: sphinx-autogen: raises AttributeError ``` ### 2.3.0 ``` ===================================== Incompatible changes -------------------- * 6742: ``end-before`` option of :rst:dir:`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 :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 additonal 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/latex2e173`_) .. _latex3/latex2e173: https://github.com/latex3/latex2e/issues/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 considers ``0`` and ``1`` as a boolean value ``` ### 2.2.2 ``` ===================================== 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 :file:`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 ``` ### 2.2.1 ``` ===================================== 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 ``` ### 2.2.0 ``` ===================================== 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`` 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()`` 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 to ``app.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: :rst:dir:`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 ``` ### 2.1.2 ``` ===================================== Bugs fixed ---------- * 6497: custom lexers fails highlighting when syntax error * 6478, 6488: info field lists are incorrectly recognized ``` ### 2.1.1 ``` ===================================== Incompatible changes -------------------- * 6447: autodoc: Stop to generate document for undocumented module variables Bugs fixed ---------- * 6442: LaTeX: admonitions of :rst:dir:`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 ``` ### 2.1.0 ``` ===================================== 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 :ref:`deprecation APIs list <dev-deprecated-apis>`. 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 * 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: :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 to :rst:dir:`py:function` directive * py domain: Add new options to :rst:dir:`py:method` directive - ``:abstractmethod:`` - ``:async:`` - ``:classmethod:`` - ``:property:`` - ``:staticmethod:`` * rst domain: Add :rst:dir:`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 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) ``` ### 2.0.1 ``` ===================================== 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 - :confval:`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.0 ``` * 6196: py domain: unexpected prefix is generated Testing -------- ``` ### 2.0.0b2 ``` * Add a helper function: ``sphinx.testing.restructuredtext.parse()`` ``` ### 2.0.0b1 ``` * Stop to use ``SPHINX_TEST_TEMPDIR`` envvar ``` ### 1.8.5 ``` ===================================== 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 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 ``` ### 1.8.4 ``` ===================================== 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 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 :file:`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 ``` ### 1.8.3 ``` ===================================== 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 :doc:`/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 ``` ### 1.8.2 ``` ===================================== 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 ``` ### 1.8.1 ``` ===================================== 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 in :file:`conf.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 ``` ### 1.8.0 ``` ===================================== Dependencies ------------ ``` ### 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 ``` * 5083: Fix wrong make.bat option for internationalization. * 5115: napoleon: add admonitions added by 4613 to the docs. ``` ### 1.7.9 ``` ===================================== Features added -------------- * 5359: Make generated texinfo files reproducible by sorting the anchors Bugs fixed ---------- * 5361: crashed on incremental build if document uses include directive ``` ### 1.7.8 ``` ===================================== 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 ``` ### 1.7.7 ``` ===================================== 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 ``` ### 1.7.6 ``` ===================================== Bugs fixed ---------- * 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 ``` ### 1.7.5 ``` ===================================== 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 ``` ### 1.7.4 ``` ===================================== Bugs fixed ---------- * 4885, 4887: domains: Crashed with duplicated objects * 4889: latex: sphinx.writers.latex causes recursive import ``` ### 1.7.3 ``` ===================================== 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 ``` ### 1.7.2 ``` ===================================== 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 ``` ### 1.7.1 ``` ===================================== 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 <http://www.sphinx-doc.org/en/master/extdev/index.htmldeprecated-apis>`_ 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.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.0 ``` ===================================== Dependencies ------------ ``` ### 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.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.0b1 ``` * Add support for docutils 0.14 * Add tests for the ``sphinx.ext.inheritance_diagram`` extension. ``` ### 1.6.7 ``` ===================================== 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`` ``` ### 1.6.6 ``` ===================================== Features added -------------- * 4181: autodoc: Sort dictionary keys when possible * ``VerbatimHighlightColor`` is a new :ref:`LaTeX 'sphinxsetup' <latexsphinxsetup>` 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: ``` ### 1.6.5 ``` ===================================== 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] :file:`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`` extension * Failed to convert reST parser error to warning (refs: 4132) ```
Links - PyPI: https://pypi.org/project/sphinx - Changelog: https://pyup.io/changelogs/sphinx/ - Homepage: http://sphinx-doc.org/
pyup-bot commented 4 years ago

Closing this in favor of #320