search

kip-hart / MicroStructPy

Microstructure modeling, mesh generation, analysis, and visualization.
https://docs.microstructpy.org
MIT License
69 stars 19 forks source link

Update sphinx to 3.1.0 #21

Closed pyup-bot closed 4 years ago

pyup-bot commented 4 years ago

This PR updates sphinx from 2.2.1 to 3.1.0.

Changelog ### 3.1.0 ``` ============================== Dependencies ------------ * 7746: mathjax: Update to 2.7.5 Incompatible changes -------------------- * 7477: imgconverter: Invoke "magick convert" command by default on Windows Deprecated ---------- * The first argument for sphinx.ext.autosummary.generate.AutosummaryRenderer has been changed to Sphinx object * ``sphinx.ext.autosummary.generate.AutosummaryRenderer`` takes an object type as an argument * The ``ignore`` argument of ``sphinx.ext.autodoc.Documenter.get_doc()`` * The ``template_dir`` argument of ``sphinx.ext.autosummary.generate. AutosummaryRenderer`` * The ``module`` argument of ``sphinx.ext.autosummary.generate. find_autosummary_in_docstring()`` * The ``builder`` argument of ``sphinx.ext.autosummary.generate. generate_autosummary_docs()`` * The ``template_dir`` argument of ``sphinx.ext.autosummary.generate. generate_autosummary_docs()`` * The ``ignore`` argument of ``sphinx.util.docstring.prepare_docstring()`` * ``sphinx.ext.autosummary.generate.AutosummaryRenderer.exists()`` * ``sphinx.util.rpartition()`` Features added -------------- * LaTeX: Make the ``toplevel_sectioning`` setting optional in LaTeX theme * LaTeX: Allow to override papersize and pointsize from LaTeX themes * LaTeX: Add :confval:`latex_theme_options` to override theme options * 7410: Allow to suppress "circular toctree references detected" warnings using :confval:`suppress_warnings` * C, added scope control directives, :rst:dir:`c:namespace`, :rst:dir:`c:namespace-push`, and :rst:dir:`c:namespace-pop`. * 2044: autodoc: Suppress default value for instance attributes * 7473: autodoc: consider a member public if docstring contains ``:meta public:`` in info-field-list * 7487: autodoc: Allow to generate docs for singledispatch functions by py:autofunction * 7143: autodoc: Support final classes and methods * 7384: autodoc: Support signatures defined by ``__new__()``, metaclasses and builtin base classes * 2106: autodoc: Support multiple signatures on docstring * 4422: autodoc: Support GenericAlias in Python 3.7 or above * 3610: autodoc: Support overloaded functions * 7722: autodoc: Support TypeVar * 7466: autosummary: headings in generated documents are not translated * 7490: autosummary: Add ``:caption:`` option to autosummary directive to set a caption to the toctree * 7469: autosummary: Support module attributes * 248, 6040: autosummary: Add ``:recursive:`` option to autosummary directive to generate stub files recursively * 4030: autosummary: Add :confval:`autosummary_context` to add template variables for custom templates * 7530: html: Support nested <kbd> elements * 7481: html theme: Add right margin to footnote/citation labels * 7482, 7717: html theme: CSS spacing for code blocks with captions and line numbers * 7443: html theme: Add new options :confval:`globaltoc_collapse` and :confval:`globaltoc_includehidden` to control the behavior of globaltoc in sidebar * 7484: html theme: Avoid clashes between sidebar and other blocks * 7476: html theme: Relbar breadcrumb should contain current page * 7506: html theme: A canonical URL is not escaped * 7533: html theme: Avoid whitespace at the beginning of genindex.html * 7541: html theme: Add a "clearer" at the end of the "body" * 7542: html theme: Make admonition/topic/sidebar scrollable * 7543: html theme: Add top and bottom margins to tables * 7695: html theme: Add viewport meta tag for basic theme * 7721: html theme: classic: default codetextcolor/codebgcolor doesn't override Pygments * C and C++: allow semicolon in the end of declarations. * C++, parse parameterized noexcept specifiers. * 7294: C++, parse expressions with user-defined literals. * C++, parse trailing return types. * 7143: py domain: Add ``:final:`` option to :rst:dir:`py:class:`, :rst:dir:`py:exception:` and :rst:dir:`py:method:` directives * 7596: py domain: Change a type annotation for variables to a hyperlink * 7770: std domain: :rst:dir:`option` directive support arguments in the form of ``foo[=bar]`` * 7582: napoleon: a type for attribute are represented like type annotation * 7734: napoleon: overescaped trailing underscore on attribute * 7247: linkcheck: Add :confval:`linkcheck_request_headers` to send custom HTTP headers for specific host * 7792: setuptools: Support ``--verbosity`` option * 7683: Add ``allowed_exceptions`` parameter to ``Sphinx.emit()`` to allow handlers to raise specified exceptions * 7295: C++, parse (trailing) requires clauses. Bugs fixed ---------- * 6703: autodoc: incremental build does not work for imported objects * 7564: autodoc: annotations not to be shown for descriptors * 6588: autodoc: Decorated inherited method has no documentation * 7469: autodoc: The change of autodoc-process-docstring for variables is cached unexpectedly * 7559: autodoc: misdetects a sync function is async * 6857: autodoc: failed to detect a classmethod on Enum class * 7562: autodoc: a typehint contains spaces is wrongly rendered under autodoc_typehints='description' mode * 7551: autodoc: failed to import nested class * 7362: autodoc: does not render correct signatures for built-in functions * 7654: autodoc: ``Optional[Union[foo, bar]]`` is presented as ``Union[foo, bar, None]`` * 7629: autodoc: autofunction emits an unfriendly warning if an invalid object specified * 7650: autodoc: undecorated signature is shown for decorated functions * 7676: autodoc: typo in the default value of autodoc_member_order * 7676: autodoc: wrong value for :member-order: option is ignored silently * 7676: autodoc: member-order="bysource" does not work for C module * 3673: autodoc: member-order="bysource" does not work for a module having __all__ * 7668: autodoc: wrong retann value is passed to a handler of autodoc-proccess-signature * 7711: autodoc: fails with ValueError when processing numpy objects * 7791: autodoc: TypeError is raised on documenting singledispatch function * 7551: autosummary: a nested class is indexed as non-nested class * 7661: autosummary: autosummary directive emits warnings twices if failed to import the target module * 7685: autosummary: The template variable "members" contains imported members even if :confval:`autossummary_imported_members` is False * 7671: autosummary: The location of import failure warning is missing * 7535: sphinx-autogen: crashes when custom template uses inheritance * 7536: sphinx-autogen: crashes when template uses i18n feature * 7781: sphinx-build: Wrong error message when outdir is not directory * 7653: sphinx-quickstart: Fix multiple directory creation for nested relpath * 2785: html: Bad alignment of equation links * 7718: html theme: some themes does not respect background color of Pygments style (agogo, haiku, nature, pyramid, scrolls, sphinxdoc and traditional) * 7544: html theme: inconsistent padding in admonitions * 7581: napoleon: bad parsing of inline code in attribute docstrings * 7628: imgconverter: runs imagemagick once unnecessary for builders not supporting images * 7610: incorrectly renders consecutive backslashes for docutils-0.16 * 7646: handle errors on event handlers * 4187: LaTeX: EN DASH disappears from PDF bookmarks in Japanese documents * 7701: LaTeX: Anonymous indirect hyperlink target causes duplicated labels * 7723: LaTeX: pdflatex crashed when URL contains a single quote * 7756: py domain: The default value for positional only argument is not shown * 7760: coverage: Add :confval:`coverage_show_missing_items` to show coverage result to console * C++, fix rendering and xrefs in nested names explicitly starting in global scope, e.g., ``::A::B``. * C, fix rendering and xrefs in nested names explicitly starting in global scope, e.g., ``.A.B``. * 7763: C and C++, don't crash during display stringification of unary expressions and fold expressions. Testing -------- ``` ### 3.0.5 ``` ============================== Dependencies ------------ Incompatible changes -------------------- Deprecated ---------- Features added -------------- Bugs fixed ---------- Testing -------- ``` ### 3.0.4 ``` ===================================== Bugs fixed ---------- * 7567: autodoc: parametrized types are shown twice for generic types * 7637: autodoc: system defined TypeVars are shown in Python 3.9 * 7696: html: Updated jQuery version from 3.4.1 to 3.5.1 for security reasons * 7611: md5 fails when OpenSSL FIPS is enabled * 7626: release package does not contain ``CODE_OF_CONDUCT`` ``` ### 3.0.3 ``` ===================================== Features added -------------- * C, parse array declarators with static, qualifiers, and VLA specification. Bugs fixed ---------- * 7516: autodoc: crashes if target object raises an error on accessing its attributes ``` ### 3.0.2 ``` ===================================== Features added -------------- * C, parse attributes and add :confval:`c_id_attributes` and :confval:`c_paren_attributes` to support user-defined attributes. Bugs fixed ---------- * 7461: py domain: fails with IndexError for empty tuple in type annotation * 7510: py domain: keyword-only arguments are documented as having a default of None * 7418: std domain: :rst:role:`term` role could not match case-insensitively * 7461: autodoc: empty tuple in type annotation is not shown correctly * 7479: autodoc: Sphinx builds has been slower since 3.0.0 on mocking * C++, fix spacing issue in east-const declarations. * 7414: LaTeX: Xindy language options were incorrect * sphinx crashes with ImportError on python3.5.1 ``` ### 3.0.1 ``` ===================================== Incompatible changes -------------------- * 7418: std domain: :rst:dir:`term` role becomes case sensitive Bugs fixed ---------- * 7428: py domain: a reference to class ``None`` emits a nitpicky warning * 7445: py domain: a return annotation ``None`` in the function signature is not converted to a hyperlink when using intersphinx * 7418: std domain: duplication warning for glossary terms is case insensitive * 7438: C++, fix merging overloaded functions in parallel builds. * 7422: autodoc: fails with ValueError when using autodoc_mock_imports * 7435: autodoc: ``autodoc_typehints='description'`` doesn't suppress typehints in signature for classes/methods * 7451: autodoc: fails with AttributeError when an object returns non-string object as a ``__doc__`` member * 7423: crashed when giving a non-string object to logger * 7479: html theme: Do not include xmlns attribute with HTML 5 doctype * 7426: html theme: Escape some links in HTML templates ``` ### 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 ```
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 #22