-------------------------------------------------------------------

Sun May 14 15:27:42 UTC 2023 - Dirk Müller <dmueller@suse.com>

​

- update to 7.0.1:

  * Support `Docutils 0.20`_.

  * #11418: Clean up remaining references to

    ``sphinx.setup_command``

    following the removal of support for setuptools.

​

-------------------------------------------------------------------

Sun Apr 30 07:40:26 UTC 2023 - Martin Liška <mliska@suse.cz>

​

- Update to version 7.0.0

  * #11359: Remove long-deprecated aliases for ``MecabSplitter`` and

    ``DefaultSplitter`` in ``sphinx.search.ja``.

  * #11360: Remove deprecated ``make_old_id`` functions in domain object

    description classes.

  * #11363: Remove the Setuptools integration (``build_sphinx`` hook in

    ``setup.py``).

  * #11364: Remove deprecated ``sphinx.ext.napoleon.iterators`` module.

  * #11365: Remove support for the ``jsdump`` format in ``sphinx.search``.

  * #11366: Make ``locale`` a required argument to

    ``sphinx.util.i18n.format_date()``.

  * #11370: Remove deprecated ``sphinx.util.stemmer`` module.

  * #11371: Remove deprecated ``sphinx.pycode.ast.parse()`` function.

  * #11372: Remove deprecated ``sphinx.io.read_doc()`` function.

  * #11373: Removed deprecated ``sphinx.util.get_matching_files()`` function.

  * #11378: Remove deprecated ``sphinx.util.docutils.is_html5_writer_available()``

    function.

  * #11379: Make the ``env`` argument to ``Builder`` subclasses required.

  * #11380: autosummary: Always emit grouped import exceptions.

  * #11381: Remove deprecated ``style`` key for HTML templates.

  * #11382: Remove deprecated ``sphinx.writers.latex.LaTeXTranslator.docclasses``

    attribute.

  * #11383: Remove deprecated ``sphinx.builders.html.html5_ready`` and

    ``sphinx.builders.html.HTMLTranslator`` attributes.

  * #11385: Remove support for HTML 4 output.

​

-------------------------------------------------------------------

Wed Apr 26 16:21:27 UTC 2023 - Matej Cepl <mcepl@suse.com>

​

- For PSP packages don't include documentation at all. The

  building of Sphinx documentation is so complicated, that it is

  not possible to include it in the main package.

​

-------------------------------------------------------------------

Tue Apr 25 11:17:16 UTC 2023 - Martin Liška <mliska@suse.cz>

​

- Update to version 6.2.1

  * #11355: Revert the default type of :confval:`nitpick_ignore` and

    :confval:`nitpick_ignore_regex` to ``list``.

​

-------------------------------------------------------------------

Mon Apr 24 07:40:28 UTC 2023 - Martin Liška <mliska@suse.cz>

​

- Bump to version 6.2.0

  * Require Docutils 0.18.1 or greater.

  * LaTeX: removal of some internal TeX ``\dimen`` registers (not previously

    publicly documented) as per 5.1.0 code comments in ``sphinx.sty``:

    ``\sphinxverbatimsep``, ``\sphinxverbatimborder``, ``\sphinxshadowsep``,

    ``\sphinxshadowsize``, and ``\sphinxshadowrule``. (refs: #11105)

  * Remove ``.egg`` support from pycode ``ModuleAnalyser``; Python eggs are a

    now-obsolete binary distribution format

  * #11089: Remove deprecated code in ``sphinx.builders.linkcheck``.

    Patch by Daniel Eades

  * Remove internal-only ``sphinx.locale.setlocale``

  * #11247: Deprecate the legacy ``intersphinx_mapping`` format

  * ``sphinx.util.osutil.cd`` is deprecated in favour of ``contextlib.chdir``.

  * #11277: :rst:dir:`autoproperty` allows the return type to be specified as

    a type comment (e.g., ``# type: () -> int``). Patch by Bénédikt Tran

  * #10811: Autosummary: extend ``__all__`` to imported members for template rendering

    when option ``autosummary_ignore_module_all`` is set to ``False``. Patch by

    Clement Pinard

  * #11147: Add a ``content_offset`` parameter to ``nested_parse_with_titles()``,

    allowing for correct line numbers during nested parsing.

    Patch by Jeremy Maitin-Shepard

  * Update to Unicode CLDR 42

  * Add a ``--jobs`` synonym for ``-j``. Patch by Hugo van Kemenade

  * LaTeX: a command ``\sphinxbox`` for styling text elements with a (possibly

    rounded) box, optional background color and shadow, has been added.

    See :ref:`sphinxbox`. (refs: #11224)

  * LaTeX: add ``\sphinxstylenotetitle``, ..., ``\sphinxstylewarningtitle``, ...,

    for an extra layer of mark-up freeing up ``\sphinxstrong`` for other uses.

    See :ref:`latex-macros`. (refs: #11267)

  * LaTeX: :dudir:`note`, :dudir:`hint`, :dudir:`important` and :dudir:`tip` can

    now each be styled as the other admonitions, i.e. possibly with a background

    color, individual border widths and paddings, possibly rounded corners, and

    optional shadow.  See :ref:`additionalcss`. (refs: #11234)

  * LaTeX: admonitions and :dudir:`topic` (and

    :dudir:`contents <table-of-contents>`) directives, and not only

    :rst:dir:`code-block`, support ``box-decoration-break=slice``.

  * LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: #11243)

  * LaTeX: new options ``noteTextColor``, ``noteTeXextras`` et al.

    See :ref:`additionalcss`.

  * LaTeX: support elliptical corners in rounded boxes. (refs: #11254)

  * #11150: Include source location in highlighting warnings, when lexing fails.

    Patch by Jeremy Maitin-Shepard

  * #11281: Support for :confval:`imgmath_latex` ``= 'tectonic'`` or

    ``= 'xelatex'``.  Patch by Dimitar Dimitrov

  * #11109, #9643: Add :confval:`python_display_short_literal_types` option for

    condensed rendering of ``Literal`` types.

  * #11079: LaTeX: figures with align attribute may disappear and strangely impact

    following lists

  * #11093: LaTeX: fix "multiply-defined references" PDF build warnings when one or

    more reST labels directly precede an :rst:dir:`py:module` or :rst:dir:`automodule`

    directive. Patch by Bénédikt Tran (picnixz)

  * #11110: LaTeX: Figures go missing from latex pdf if their files have the same

    base name and they use a post transform.  Patch by aaron-cooper

  * LaTeX: fix potential color leak from shadow to border of rounded boxes, if

    shadow color is set but border color is not

  * LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames

    respective to contents (when using rounded corners)

  * #11235: LaTeX: added ``\color`` in topic (or admonition) contents may cause color

    leak to the shadow and border at a page break

  * #11264: LaTeX: missing space before colon after "Voir aussi" for :rst:dir:`seealso`

    directive in French

  * #11268: LaTeX: longtable with left alignment breaks out of current list

    indentation context in PDF.  Thanks to picnixz.

  * #11274: LaTeX: external links are not properly escaped for ``\sphinxupquote``

    compatibility

  * #11147: Fix source file/line number info in object description content and in

    other uses of ``nested_parse_with_titles``.  Patch by Jeremy Maitin-Shepard.

  * #11192: Restore correct parallel search index building.

    Patch by Jeremy Maitin-Shepard

  * Use the new Transifex ``tx`` client

  * Fail testing when any Python warnings are emitted

  * Migrate remaining ``unittest.TestCase`` style test functions to pytest style

  * Remove tests that rely on setuptools

- Remove alabaster-0713-compat.patch upstreamed patch.

- Update intersphinx links.

- Install filelock python dependency for tests.

- Run tests parallel.

​

-------------------------------------------------------------------

Fri Apr 21 12:21:22 UTC 2023 - Dirk Müller <dmueller@suse.com>

​

- add sle15_python_module_pythons (jsc#PED-68)

​

-------------------------------------------------------------------

Thu Apr 13 22:45:03 UTC 2023 - Matej Cepl <mcepl@suse.com>

​

- Make calling of %{sle15modernpython} optional.

​

-------------------------------------------------------------------

Sun Jan 29 18:59:21 UTC 2023 - Dirk Müller <dmueller@suse.com>

​

- add alabaster-0713-compat.patch to fix testsuite failure with

  newer alabaster theme.

​

-------------------------------------------------------------------

Tue Jan 10 18:02:04 UTC 2023 - Martin Liška <mliska@suse.cz>

​

- Update to version 6.1.3

  * #11116: Reverted to previous Sphinx 5 node copying method

  * #11117: Reverted changes to parallel image processing from Sphinx 6.1.0

  * #11119: Supress ``ValueError`` in the ``linkcheck`` builder

​

-------------------------------------------------------------------

Sun Jan  8 09:18:41 UTC 2023 - Martin Liška <mliska@suse.cz>

​

- Update to version 6.1.2

  * #11101: LaTeX: div.topic_padding key of sphinxsetup documented at 5.1.0 was

    implemented with name topic_padding

  * #11099: LaTeX: shadowrule key of sphinxsetup causes PDF build to crash since

    Sphinx 5.1.0

  * #11096: LaTeX: shadowsize key of sphinxsetup causes PDF build to crash since

    Sphinx 5.1.0

  * #11095: LaTeX: shadow of topic and contents boxes not in page margin since

    Sphinx 5.1.0

  * #11100: Fix copying images when running under parallel mode.

- Disable test_copy_images tests as they need an internet access.

​

-------------------------------------------------------------------

Thu Jan  5 18:09:36 UTC 2023 - Martin Liška <mliska@suse.cz>

​

- Update to version 6.1.1

  * #11091: Fix ``util.nodes.apply_source_workaround`` for ``literal_block`` nodes

    with no source information in the node or the node's parents.

  * Adopted the `Ruff`_ code linter.

    .. _Ruff: https://github.com/charliermarsh/ruff

  * #10979: gettext: Removed support for pluralisation in ``get_translation``.

    This was unused and complicated other changes to ``sphinx.locale``.

  * ``sphinx.util`` functions:

     * Renamed ``sphinx.util.typing.stringify()``

       to ``sphinx.util.typing.stringify_annotation()``

     * Moved ``sphinx.util.xmlname_checker()``

       to ``sphinx.builders.epub3._XML_NAME_PATTERN``

​

     Moved to ``sphinx.util.display``:

​

     * ``sphinx.util.status_iterator``

     * ``sphinx.util.display_chunk``

     * ``sphinx.util.SkipProgressMessage``

     * ``sphinx.util.progress_message``

​

     Moved to ``sphinx.util.http_date``:

​

     * ``sphinx.util.epoch_to_rfc1123``

     * ``sphinx.util.rfc1123_to_epoch``

​

     Moved to ``sphinx.util.exceptions``:

​

     * ``sphinx.util.save_traceback``

     * ``sphinx.util.format_exception_cut_frames``

​

  * Cache doctrees in the build environment during the writing phase.

  * Make all writing phase tasks support parallel execution.

  * #11072: Use PEP 604 (``X | Y``) display conventions for ``typing.Optional``

    and ``typing.Optional`` types within the Python domain and autodoc.

  * #10700: autodoc: Document ``typing.NewType()`` types as classes rather than

    'data'.

  * Cache doctrees between the reading and writing phases.

  * #10962: HTML: Fix the multi-word key name lookup table.

  * Fixed support for Python 3.12 alpha 3 (changes in the ``enum`` module).

  * #11069: HTML Theme: Removed outdated "shortcut" link relation keyword.

  * #10952: Properly terminate parallel processes on programme interuption.

  * #10988: Speed up ``TocTree.resolve()`` through more efficient copying.

  * #6744: LaTeX: support for seealso directive should be via an environment

    to allow styling.

  * #11074: LaTeX: Can't change sphinxnote to use sphinxheavybox starting with

    5.1.0

  * Require Pygments 2.13 or later.

  * #10944: imgmath:  Fix resolving image paths for files in nested folders.

​

-------------------------------------------------------------------

Wed Jan  4 05:56:10 UTC 2023 - Martin Liška <mliska@suse.cz>

​

- Add pygments-2.14.patch in order to fix Pygments tests

  after the 2.14 release.

  gh#sphinx-doc/sphinx#11067

​

-------------------------------------------------------------------

Sat Dec 31 09:06:47 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 6.0.0

  * #10468: Drop Python 3.6 support

  * #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and

    Docutils 0.17 support. Patch by Adam Turner

  * #7405: Removed the jQuery and underscore.js JavaScript frameworks.

    These frameworks are no longer be automatically injected into themes from

    Sphinx 6.0. If you develop a theme or extension that uses the

    ``jQuery``, ``$``, or ``$u`` global objects, you need to update your

    JavaScript to modern standards, or use the mitigation below.

    The first option is to use the sphinxcontrib.jquery_ extension, which has been

    developed by the Sphinx team and contributors. To use this, add

    ``sphinxcontrib.jquery`` to the ``extensions`` list in ``conf.py``, or call

    ``app.setup_extension("sphinxcontrib.jquery")`` if you develop a Sphinx theme

    or extension.

    The second option is to manually ensure that the frameworks are present.

    To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and

    ``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory,

    and add the following to your ``layout.html``:

​

    .. code-block:: html+jinja

​

       {%- block scripts %}

           <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>

           <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>

           {{ super() }}

       {%- endblock %}

​

    .. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/

    Patch by Adam Turner.

  * #10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See

    :ref:`dev-deprecated-apis` for details. Patch by Adam Turner.

  * #10901: C Domain: Remove support for parsing pre-v3 style type directives and

    roles. Also remove associated configuration variables ``c_allow_pre_v3`` and

    ``c_warn_on_allowed_pre_v3``. Patch by Adam Turner.

  * #10924: LaTeX: adopt better looking defaults for tables and code-blocks.

    See :confval:`latex_table_style` and the ``pre_border-radius`` and

    ``pre_background-TeXcolor`` :ref:`additionalcss` for the former defaults

    and how to re-enact them if desired.

  * #10984: LaTeX: Document :confval:`latex_additional_files` behavior for files

    with ``.tex`` extension.

​

-------------------------------------------------------------------

Sun Oct 16 14:43:01 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 5.3.0

  * #10759: LaTeX: add :confval:`latex_table_style` and support the

    ``'booktabs'``, ``'borderless'``, and ``'colorrows'`` styles.

    (thanks to Stefan Wiehler for initial pull requests #6666, #6671)

  * #10840: One can cross-reference including an option value like ``:option:`--module=foobar```,

    ``:option:`--module[=foobar]``` or ``:option:`--module foobar```.

    Patch by Martin Liska.

  * #10881: autosectionlabel: Record the generated section label to the debug log.

  * #10268: Correctly URI-escape image filenames.

  * #10887: domains: Allow sections in all the content of all object description

    directives (e.g. :rst:dir:`py:function`). Patch by Adam Turner

​

-------------------------------------------------------------------

Sun Oct  2 18:47:20 UTC 2022 - Markéta Machová <mmachova@suse.com>

​

- BuildRequires just flit-core instead of flit

​

-------------------------------------------------------------------

Fri Sep 30 18:06:55 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 5.2.3

  * #10878: Fix base64 image embedding in sphinx.ext.imgmath

  * #10886: Add :nocontentsentry: flag and global domain table of contents entry

    control option. Patch by Adam Turner

​

-------------------------------------------------------------------

Tue Sep 27 15:35:11 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 5.2.2

  * #10872: Restore link targets for autodoc modules to the top of content.

    Patch by Dominic Davis-Foster.

​

-------------------------------------------------------------------

Mon Sep 26 07:06:34 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 5.2.1

  * #10861: Always normalise the ``pycon3`` lexer to ``pycon``.

  * Fix using ``sphinx.ext.autosummary`` with modules containing titles in the

    module-level docstring.

- Remove unneeded spec hunks.

​

-------------------------------------------------------------------

Sun Sep 25 15:24:42 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 5.2.0

  * #10356: Sphinx now uses declarative metadata with pyproject.toml to create packages,

    using PyPA’s build project as a build backend. Patch by Adam Turner.

  * #10286: C++, support requires clauses not just between the template parameter lists and the declaration.

  * #10755: linkcheck: Check the source URL of raw directives that use the url option.

  * #10781: Allow ref role to be used with definitions and fields.

  * #10717: HTML Search: Increase priority for full title and subtitle matches in search results

  * #10718: HTML Search: Save search result score to the HTML element for debugging

  * #10673: Make toctree accept ‘genindex’, ‘modindex’ and ‘search’ docnames

  * #6316, #10804: Add domain objects to the table of contents. Patch by Adam Turner

  * #6692: HTML Search: Include explicit index directive index entries in the search index and search results. Patch by Adam Turner

  * #10816: imgmath: Allow embedding images in HTML as base64

  * #10257: C++, ensure consistent non-specialization template argument representation.

  * #10729: C++, fix parsing of certain non-type template parameter packs.

  * #10715: Revert #10520: “Fix” use of sidebar classes in agogo.css_t

​

-------------------------------------------------------------------

Wed Jul 27 06:58:04 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 5.1.1

  * #10701: Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean``

    iterator implementation.

  * #10702: Restore compatability with third-party builders.

​

-------------------------------------------------------------------

Sun Jul 24 17:44:29 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 5.1.0

  * #10656: Support `Docutils 0.19`_. Patch by Adam Turner.

  * #10467: Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``.

    Patch by Adam Turner.

  * #9856: Deprecated ``sphinx.ext.napoleon.iterators``.

  * #10444: html theme: Allow specifying multiple CSS files through the ``stylesheet``

    setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings.

  * #10366: std domain: Add support for emphasising placeholders in :rst:dir:`option`

    directives through a new :confval:`option_emphasise_placeholders` configuration

    option.

  * #10439: std domain: Use the repr of some variables when displaying warnings,

    making whitespace issues easier to identify.

  * #10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by

    Pradyun Gedam.

  * #10648: LaTeX: CSS-named-alike additional :ref:`'sphinxsetup' <latexsphinxsetup>`

    keys allow to configure four separate border-widths, four paddings, four

    corner radii, a shadow (possibly inset), colours for border, background, shadow

    for each of the code-block, topic, attention, caution, danger, error and warning

    directives.

  * #10655: LaTeX: Explain non-standard encoding in LatinRules.xdy

  * #10599: HTML Theme: Wrap consecutive footnotes in an ``<aside>`` element when

    using Docutils 0.18 or later, to allow for easier styling. This matches the

    behaviour introduced in Docutils 0.19. Patch by Adam Turner.

  * #10518: config: Add ``include_patterns`` as the opposite of ``exclude_patterns``.

    Patch by Adam Turner.

  * #10594: HTML Theme: field term colons are doubled if using Docutils 0.18+

  * #10596: Build failure if Docutils version is 0.18 (not 0.18.1) due

    to missing ``Node.findall()``

  * #10506: LaTeX: build error if highlighting inline code role in figure caption

    (refs: #10251)

  * #10634: Make -P (pdb) option work better with exceptions triggered from events

  * #10031: py domain: Fix spurious whitespace in unparsing various operators (``+``,

    ``-``, ``~``, and ``**``). Patch by Adam Turner.

  * #10460: logging: Always show node source locations as absolute paths.

  * HTML Search: HTML tags are displayed as a part of object name

  * HTML Search: search snipets should not be folded

  * HTML Search: Minor errors are emitted on fetching search snipets

  * HTML Search: The markers for header links are shown in the search result

  * #10520: HTML Theme: Fix use of sidebar classes in ``agogo.css_t``.

  * #6679: HTML Theme: Fix inclusion of hidden toctrees in the agogo theme.

  * #10566: HTML Theme: Fix enable_search_shortcuts does not work

  * #8686: LaTeX: Text can fall out of code-block at end of page and leave artifact

    on next page

  * #10633: LaTeX: user injected ``\color`` commands in topic or admonition boxes may

    cause color leaks in PDF due to upstream `framed.sty <https://ctan.org/pkg/framed>`_

    bug

  * #10638: LaTeX: framed coloured boxes in highlighted code (e.g. highlighted

    diffs using Pygments style ``'manni'``) inherit thickness of code-block frame

  * #10647: LaTeX: Only one ``\label`` is generated for ``desc_signature`` node

    even if it has multiple node IDs

  * #10579: i18n: UnboundLocalError is raised on translating raw directive

  * #9577, #10088: py domain: Fix warning for duplicate Python references when

    using ``:any:`` and autodoc.

  * #10548: HTML Search: fix minor summary issues.

- Add update-intersphinx.sh and get all objects.inv files.

- Add Adam Turner's GPG key (61F0FB52) to python-Sphinx.keyring.

​

-------------------------------------------------------------------

Tue Jul 19 18:05:49 UTC 2022 - Matej Cepl <mcepl@suse.com>

​

- (bsc#1201272) Add a missing dependency of latex subpackage on

  tex(tgtermes.sty).

- Add python-Sphinx.keyring

​

-------------------------------------------------------------------

Fri Jun 17 14:09:37 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 5.0.2

* #10523: HTML Theme: Expose the Docutils's version info tuple as a template

  variable, ``docutils_version_info``. Patch by Adam Turner.

* #10538: autodoc: Inherited class attribute having docstring is documented even

  if :confval:`autodoc_inherit_docstring` is disabled

* #10509: autosummary: autosummary fails with a shared library

* #10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.

* #10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+.

  Patch by Adam Turner.

* #10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.

​

-------------------------------------------------------------------

Fri Jun  3 08:12:27 UTC 2022 - Michael Ströder <michael@stroeder.com>

​

- Update to version 5.0.1

  * #10498: gettext: TypeError is raised when sorting warning messages if a node

    has no line number

  * #10493: html theme: :rst:dir:`topic` directive is rendered incorrectly with

    docutils-0.18

  * #10495: IndexError is raised for a :rst:role:`kbd` role having a separator

​

-------------------------------------------------------------------

Mon May 30 09:20:27 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 5.0.0:

​

  * #10164: Support `Docutils 0.18`_. Patch by Adam Turner.

  * #10031: autosummary: ``sphinx.ext.autosummary.import_by_name()`` now raises

    ``ImportExceptionGroup`` instead of ``ImportError`` when it failed to import

    target object.  Please handle the exception if your extension uses the

    function to import Python object.  As a workaround, you can disable the

    behavior via ``grouped_exception=False`` keyword argument until v7.0.

  * #9962: texinfo: Customizing styles of emphasized text via ``@definfoenclose``

    command was not supported because the command was deprecated since texinfo 6.8

  * #2068: :confval:`intersphinx_disabled_reftypes` has changed default value

    from an empty list to ``['std:doc']`` as avoid too surprising silent

    intersphinx resolutions.

    To migrate: either add an explicit inventory name to the references

    intersphinx should resolve, or explicitly set the value of this configuration

    variable to an empty list.

  * #10197: html theme: Reduce ``body_min_width`` setting in basic theme to 360px

  * #9999: LaTeX: separate terms from their definitions by a CR (refs: #9985)

  * #10062: Change the default language to ``'en'`` if any language is not set in

    ``conf.py``

  * #10474: :confval:`language` does not accept ``None`` as it value.  The default

    value of ``language`` becomes to ``'en'`` now.

    * #10028: jQuery and underscore.js will no longer be automatically injected into

    themes from Sphinx 6.0. If you develop a theme or extension that uses the

    ``jQuery``, ``$``, or ``$u`` global objects, you need to update your

    JavaScript or use the mitigation below.

​

    To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and

    ``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory,

    and add the following to your ``layout.html``:

​

    .. _the Sphinx repository: https://github.com/sphinx-doc/sphinx/tree/v4.3.2/sphinx/themes/basic/static

    .. code-block:: html+jinja

​

       {%- block scripts %}

           <script src="{{ pathto('_static/jquery.js', resource=True) }}"></script>

           <script src="{{ pathto('_static/underscore.js', resource=True) }}"></script>

           {{ super() }}

       {%- endblock %}

  * setuptools integration.  The ``build_sphinx`` sub-command for setup.py is

    marked as deprecated to follow the policy of setuptools team.

  * The ``locale`` argument of ``sphinx.util.i18n:babel_format_date()`` becomes

    required

  * The ``language`` argument of ``sphinx.util.i18n:format_date()`` becomes

    required

  * ``sphinx.builders.html.html5_ready``

  * ``sphinx.io.read_doc()``

  * ``sphinx.util.docutils.__version_info__``

  * ``sphinx.util.docutils.is_html5_writer_available()``

  * ``sphinx.writers.latex.LaTeXWriter.docclasses``

  * #9075: autodoc: The default value of :confval:`autodoc_typehints_format` is

    changed to ``'smart'``.  It will suppress the leading module names of

    typehints (ex. ``io.StringIO`` -> ``StringIO``).

  * #8417: autodoc: ``:inherited-members:`` option now takes multiple classes.  It

    allows to suppress inherited members of several classes on the module at once

    by specifying the option to :rst:dir:`automodule` directive

  * #9792: autodoc: Add new option for ``autodoc_typehints_description_target`` to

    include undocumented return values but not undocumented parameters.

  * #10285: autodoc: singledispatch functions having typehints are not documented

  * autodoc: :confval:`autodoc_typehints_format` now also applies to attributes,

    data, properties, and type variable bounds.

  * #10258: autosummary: Recognize a documented attribute of a module as

    non-imported

  * #10028: Removed internal usages of JavaScript frameworks (jQuery and

    underscore.js) and modernised ``doctools.js`` and ``searchtools.js`` to

    EMCAScript 2018.

  * #10302: C++, add support for conditional expressions (``?:``).

  * #5157, #10251: Inline code is able to be highlighted via :rst:dir:`role`

    directive

  * #10337: Make sphinx-build faster by caching Publisher object during build

  * #10200: apidoc: Duplicated submodules are shown for modules having both .pyx

    and .so files

  * #10279: autodoc: Default values for keyword only arguments in overloaded

    functions are rendered as a string literal

  * #10280: autodoc: :confval:`autodoc_docstring_signature` unexpectedly generates

    return value typehint for constructors if docstring has multiple signatures

  * #10266: autodoc: :confval:`autodoc_preserve_defaults` does not work for

    mixture of keyword only arguments with/without defaults

  * #10310: autodoc: class methods are not documented when decorated with mocked

    function

  * #10305: autodoc: Failed to extract optional forward-ref'ed typehints correctly

    via :confval:`autodoc_type_aliases`

  * #10421: autodoc: :confval:`autodoc_preserve_defaults` doesn't work on class

    methods

  * #10214: html: invalid language tag was generated if :confval:`language`

    contains a country code (ex. zh_CN)

  * #9974: html: Updated jQuery version from 3.5.1 to 3.6.0

  * #10236: html search: objects are duplicated in search result

  * #9962: texinfo: Deprecation message for ``@definfoenclose`` command on

    bulding texinfo document

  * #10000: LaTeX: glossary terms with common definition are rendered with

    too much vertical whitespace

  * #10188: LaTeX: alternating multiply referred footnotes produce a ``?`` in

    pdf output

  * #10363: LaTeX: make ``'howto'`` title page rule use ``\linewidth`` for

    compatibility with usage of a ``twocolumn`` class option

  * #10318: ``:prepend:`` option of :rst:dir:`literalinclude` directive does not

    work with ``:dedent:`` option

    * #9575: autodoc: The annotation of return value should not be shown when

    ``autodoc_typehints="description"``

  * #9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when

    ``autodoc_typehints="description"``

  * #8180: autodoc: Docstring metadata ignored for attributes

  * #10443: epub: EPUB builder can't detect the mimetype of .webp file

  * #10104: gettext: Duplicated locations are shown if 3rd party extension does

    not provide correct information

  * #10456: py domain: ``:meta:`` fields are displayed if docstring contains two

    or more meta-field

  * #9096: sphinx-build: the value of progress bar for paralle build is wrong

  * #10110: sphinx-build: exit code is not changed when error is raised on

    builder-finished event

​

-------------------------------------------------------------------

Mon Mar 28 08:29:11 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 4.5.0:

  * #10112: extlinks: Disable hardcoded links detector by default

  * #9993, #10177: std domain: Disallow to refer an inline target via

    :rst:role:`ref` role

  * ``sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()``

  * #10260: Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring

  * #10234: autosummary: Add "autosummary" CSS class to summary tables

  * #10125: extlinks: Improve suggestion message for a reference having title

  * #10112: extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable

    hardcoded links detector feature

  * #9494, #9456: html search: Add a config variable

    :confval:`html_show_search_summary` to enable/disable the search summaries

  * #9337: HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:'/' as

           a Quick search shortcut and :kbd:`Esc` shortcut that

           removes search highlighting.

  * #10107: i18n: Allow to suppress translation warnings by adding ``#noqa``

    comment to the tail of each translation message

  * #10252: C++, support attributes on classes, unions, and enums.

  * #10253: :rst:dir:`pep` role now generates URLs based on peps.python.org

  * #9876: autodoc: Failed to document an imported class that is built from native

    binary module

  * #10133: autodoc: Crashed when mocked module is used for type annotation

  * #10146: autodoc: :confval:`autodoc_default_options` does not support

    ``no-value`` option

  * #9971: autodoc: TypeError is raised when the target object is annotated by

    unhashable object

  * #10205: extlinks: Failed to compile regexp on checking hardcoded links

  * #10277: html search: Could not search short words (ex. "use")

  * #9529: LaTeX: named auto numbered footnote (ex. ``[#named]``) that is referred

    multiple times was rendered to a question mark

  * #9924: LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical

    spacing in Latexpdf

  * #10158: LaTeX: excessive whitespace since v4.4.0 for undocumented

    variables/structure members 

  * #10175: LaTeX: named footnote reference is linked to an incorrect footnote if

    the name is also used in the different document

  * #10269: manpage: Failed to resolve the title of :ref: cross references

  * #10179: i18n: suppress "rST localization" warning

  * #10118: imgconverter: Unnecessary availablity check is called for remote URIs

  * #10181: napoleon: attributes are displayed like class attributes for google

    style docstrings when :confval:`napoleon_use_ivar` is enabled

  * #10122: sphinx-build: make.bat does not check the installation of sphinx-build

    command before showing help

- Update url for requests.inv.

​

-------------------------------------------------------------------

Fri Jan 28 11:01:23 UTC 2022 - Matej Cepl <mcepl@suse.com>

​

- SPEC cleanup

​

-------------------------------------------------------------------

Thu Jan 20 14:26:44 UTC 2022 - Ben Greiner <code@bnavigator.de>

​

- Fix missing install_requires dependencies.

​

-------------------------------------------------------------------

Wed Jan 19 16:49:53 UTC 2022 - Matej Cepl <mcepl@suse.com>

​

- I know it looks cool to have URLs for all Source files, but these are

  files in VCS and they are inherently very unstable, so it breaks our

  checks.

​

-------------------------------------------------------------------

Sun Jan 16 18:25:51 UTC 2022 - Martin Liška <mliska@suse.cz>

​

- Update to version 4.4.0:

  * #10007: Use ``importlib_metadata`` for python-3.9 or older

  * #10007: Drop ``setuptools``

  * #9075: autodoc: Add a config variable :confval:`autodoc_typehints_format`

    to suppress the leading module names of typehints of function signatures (ex.

    ``io.StringIO`` -> ``StringIO``)

  * #9831: Autosummary now documents only the members specified in a module's

    ``__all__`` attribute if :confval:`autosummary_ignore_module_all` is set to

    ``False``. The default behaviour is unchanged. Autogen also now supports

    this behavior with the ``--respect-module-all`` switch.

  * #9555: autosummary: Improve error messages on failure to load target object

  * #9800: extlinks: Emit warning if a hardcoded link is replaceable

    by an extlink, suggesting a replacement.

  * #9961: html: Support nested <kbd> HTML elements in other HTML builders

  * #10013: html: Allow to change the loading method of JS via ``loading_method``

    parameter for :meth:`Sphinx.add_js_file()`

  * #9551: html search: "Hide Search Matches" link removes "highlight" parameter

    from URL

  * #9815: html theme: Wrap sidebar components in div to allow customizing their

    layout via CSS

  * #9827: i18n: Sort items in glossary by translated terms

  * #9899: py domain: Allows to specify cross-reference specifier (``.`` and

    ``~``) as ``:type:`` option

  * #9894: linkcheck: add option ``linkcheck_exclude_documents`` to disable link

    checking in matched documents.

  * #9793: sphinx-build: Allow to use the parallel build feature in macOS on macOS

    and Python3.8+

  * #10055: sphinx-build: Create directories when ``-w`` option given

  * #9993: std domain: Allow to refer an inline target (ex. ``_`target name```)

    via :rst:role:`ref` role

  * #9981: std domain: Strip value part of the option directive from general index

  * #9391: texinfo: improve variable in ``samp`` role

  * #9578: texinfo: Add :confval:`texinfo_cross_references` to disable cross

    references for readability with standalone readers

  * #9822 (and #9062), add new Intersphinx role :rst:role:`external` for explict

    lookup in the external projects, without resolving to the local project.

  * #9866: autodoc: doccomment for the imported class was ignored

  * #9883: autodoc: doccomment for the alias to mocked object was ignored

  * #9908: autodoc: debug message is shown on building document using NewTypes

    with Python 3.10

  * #9968: autodoc: instance variables are not shown if __init__ method has

    position-only-arguments

  * #9194: autodoc: types under the "typing" module are not hyperlinked

  * #10009: autodoc: Crashes if target object raises an error on getting docstring

  * #10058: autosummary: Imported members are not shown when

    ``autodoc_class_signature = 'separated'``

  * #9947: i18n: topic directive having a bullet list can't be translatable

  * #9878: mathjax: MathJax configuration is placed after loading MathJax itself

  * #9932: napoleon: empty "returns" section is generated even if no description

  * #9857: Generated RFC links use outdated base url

  * #9909: HTML, prevent line-wrapping in literal text.

  * #10061: html theme: Configuration values added by themes are not be able to

    override from conf.py

  * #10073: imgconverter: Unnecessary availablity check is called for "data" URIs

  * #9925: LaTeX: prohibit also with ``'xelatex'`` line splitting at dashes of

    inline and parsed literals

  * #9944: LaTeX: extra vertical whitespace for some nested declarations

  * #9940: LaTeX: Multi-function declaration in Python domain has cramped

    vertical spacing in latexpdf output

  * #10015: py domain: types under the "typing" module are not hyperlinked defined

    at info-field-list

  * #9390: texinfo: Do not emit labels inside footnotes

  * #9413: xml: Invalid XML was generated when cross referencing python objects

  * #9979: Error level messages were displayed as warning messages

  * #10057: Failed to scan documents if the project is placed onto the root

    directory

  * #9636: code-block: ``:dedent:`` without argument did strip newlines

- Add new intersphinx mapping file: readthedocs.inv.

- Fix %fdupes.

- Remove python-Sphinx-rpmlintrc as it is not used any more.

​

-------------------------------------------------------------------

Wed Dec 22 10:11:19 UTC 2021 - Martin Liška <mliska@suse.cz>

​

- Update to version 4.3.2:

  * #9917: C and C++, parse fundamental types no matter the order of simple type

    specifiers.

​

-------------------------------------------------------------------

Sat Nov 27 21:14:22 UTC 2021 - Arun Persaud <arun@gmx.de>

​

- update to version 4.3.1:

  * Features added

    + #9864: mathjax: Support chnaging the loading method of MathJax

       to "defer" via :confval:`mathjax_options`

  * Bugs fixed

    + #9838: autodoc: AttributeError is raised on building document

       for functions decorated by functools.lru_cache

    + #9879: autodoc: AttributeError is raised on building document

       for an object having invalid __doc__ atribute

    + #9844: autodoc: Failed to process a function wrapped with

       functools.partial if :confval:`autodoc_preserve_defaults`

       enabled

    + #9872: html: Class namespace collision between autodoc

       signatures and docutils-0.17

    + #9868: imgmath: Crashed if the dvisvgm command failed to convert

       equation

    + #9864: mathjax: Failed to render equations via MathJax v2.  The

       loading method of MathJax is back to "async" method again

​

-------------------------------------------------------------------

Fri Nov 12 16:29:59 UTC 2021 - Matej Cepl <mcepl@suse.com>

​

- Explicitly Require python-sphinxcontrib-qthelp >= 1.0.2 to prevent

  bsc#1157793 and bsc#1158158 from occuring.

​

-------------------------------------------------------------------

Fri Nov 12 11:45:06 UTC 2021 - Martin Liška <mliska@suse.cz>

​

- Update rpmlintrc file.

- Update to 4.3.0:

​

  * Support Python 3.10

​

  * #9649: ``searchindex.js``: the embedded data has changed format to allow

    objects with the same name in different domains.

  * #9672: The rendering of Python domain declarations is implemented

    with more docutils nodes to allow better CSS styling.

    It may break existing styling.

  * #9672: the signature of

    :py:meth:`domains.py.PyObject.get_signature_prefix` has changed to

    return a list of nodes instead of a plain string.

  * #9695: ``domains.js.JSObject.display_prefix`` has been changed into a method

    ``get_display_prefix`` which now returns a list of nodes

    instead of a plain string.

  * #9695: The rendering of Javascript domain declarations is implemented

    with more docutils nodes to allow better CSS styling.

    It may break existing styling.

  * #9450: mathjax: Load MathJax via "defer" strategy

​

  * ``sphinx.ext.autodoc.AttributeDocumenter._datadescriptor``

  * ``sphinx.writers.html.HTMLTranslator._fieldlist_row_index``

  * ``sphinx.writers.html.HTMLTranslator._table_row_index``

  * ``sphinx.writers.html5.HTML5Translator._fieldlist_row_index``

  * ``sphinx.writers.html5.HTML5Translator._table_row_index``

​

  * #9639: autodoc: Support asynchronous generator functions

  * #9664: autodoc: ``autodoc-process-bases`` supports to inject reST snippet as a

    base class

  * #9691: C, added new info-field ``retval``

    for :rst:dir:`c:function` and :rst:dir:`c:macro`.

  * C++, added new info-field ``retval`` for :rst:dir:`cpp:function`.

  * #9618: i18n: Add :confval:`gettext_allow_fuzzy_translations` to allow "fuzzy"

    messages for translation

  * #9672: More CSS classes on Python domain descriptions

  * #9695: More CSS classes on Javascript domain descriptions

  * #9683: Revert the removal of ``add_stylesheet()`` API.  It will be kept until

    the Sphinx-6.0 release

  * #2068, add :confval:`intersphinx_disabled_reftypes` for disabling

    interphinx resolution of cross-references that do not have an explicit

    inventory specification. Specific types of cross-references can be disabled,

    e.g., ``std:doc`` or all cross-references in a specific domain,

    e.g., ``std:*``.

  * #9623: Allow to suppress "toctree contains reference to excluded document"

    warnings using :confval:`suppress_warnings`

​

  * #9630: autodoc: Failed to build cross references if :confval:`primary_domain`

    is not 'py'

  * #9644: autodoc: Crashed on getting source info from problematic object

  * #9655: autodoc: mocked object having doc comment is warned unexpectedly

  * #9651: autodoc: return type field is not generated even if

    :confval:`autodoc_typehints_description_target` is set to "documented" when

    its info-field-list contains ``:returns:`` field

  * #9657: autodoc: The base class for a subclass of mocked object is incorrect

  * #9607: autodoc: Incorrect base class detection for the subclasses of the

    generic class

  * #9755: autodoc: memory addresses are shown for aliases

  * #9752: autodoc: Failed to detect type annotation for slots attribute

  * #9756: autodoc: Crashed if classmethod does not have __func__ attribute

  * #9757: autodoc: :confval:`autodoc_inherit_docstrings` does not effect to

    overriden classmethods

  * #9781: autodoc: :confval:`autodoc_preserve_defaults` does not support

    hexadecimal numeric

  * #9630: autosummary: Failed to build summary table if :confval:`primary_domain`

    is not 'py'

  * #9670: html: Fix download file with special characters

  * #9710: html: Wrong styles for even/odd rows in nested tables

  * #9763: html: parameter name and its type annotation are not separated in HTML

  * #9649: HTML search: when objects have the same name but in different domains,

    return all of them as result instead of just one.

  * #7634: intersphinx: references on the file in sub directory are broken

  * #9737: LaTeX: hlist is rendered as a list containing "aggedright" text

  * #9678: linkcheck: file extension was shown twice in warnings

  * #9697: py domain: An index entry with parens was registered for ``py:method``

    directive with ``:property:`` option

  * #9775: py domain: Literal typehint was converted to a cross reference when

    :confval:`autodoc_typehints='description'`

  * #9708: needs_extension failed to check double-digit version correctly

  * #9688: Fix :rst:dir:`code`` does not recognize ``:class:`` option

  * #9733: Fix for logging handler flushing warnings in the middle of the docs

    build

  * #9656: Fix warnings without subtype being incorrectly suppressed

  * Intersphinx, for unresolved references with an explicit inventory,

    e.g., ``proj:myFunc``, leave the inventory prefix in the unresolved text.

​

-------------------------------------------------------------------

Wed Nov 10 13:57:29 UTC 2021 - Matej Cepl <mcepl@suse.com>

​

- Fix Provides and Obsoletes ... we cannot use python_module there

​

-------------------------------------------------------------------

Tue Sep 14 09:13:14 UTC 2021 - Martin Liška <mliska@suse.cz>

​

- Update to 4.2.0:

  * #9445: autodoc: Support class properties

  * #9479: autodoc: Emit a warning if target is a mocked object

  * #9560: autodoc: Allow to refer NewType instances with module name in Python

    3.10 or above

  * #9447: html theme: Expose the version of Sphinx in the form of tuple as a

    template variable ``sphinx_version_tuple``

  * #9594: manpage: Suppress the title of man page if description is empty

  * #9445: py domain: ``:py:property:`` directive supports ``:classmethod:``

    option to describe the class property

  * #9524: test: SphinxTestApp can take ``builddir`` as an argument

  * #9535: C and C++, support more fundamental types, including GNU extensions.

  * #9608: apidoc: apidoc does not generate a module definition for implicit

    namespace package

  * #9504: autodoc: generate incorrect reference to the parent class if the target

    class inherites the class having ``_name`` attribute

  * #9537, #9589: autodoc: Some objects under ``typing`` module are not displayed

    well with the HEAD of 3.10

  * #9487: autodoc: typehint for cached_property is not shown

  * #9509: autodoc: AttributeError is raised on failed resolving typehints

  * #9518: autodoc: autodoc_docstring_signature does not effect to ``__init__()``

    and ``__new__()``

  * #9522: autodoc: PEP 585 style typehints having arguments (ex. ``list[int]``)

    are not displayed well

  * #9481: autosummary: some warnings contain non-existing filenames

  * #9568: autosummary: summarise overlined sectioned headings correctly

  * #9600: autosummary: Type annotations which contain commas in autosummary table

    are not removed completely

  * #9481: c domain: some warnings contain non-existing filenames

  * #9481: cpp domain: some warnings contain non-existing filenames

  * #9456: html search: abbreation marks are inserted to the search result if

    failed to fetch the content of the page

  * #9617: html search: The JS requirement warning is shown if browser is slow

  * #9267: html theme: CSS and JS files added by theme were loaded twice

  * #9585: py domain: ``:type:`` option for :rst:dir:`py:property` directive does

    not create a hyperlink

  * #9576: py domain: Literal typehint was converted to a cross reference

  * #9535 comment: C++, fix parsing of defaulted function parameters that are

    function pointers.

  * #9564: smartquotes: don't adjust typography for text with

    language-highlighted ``:code:`` role.

  * #9512: sphinx-build: crashed with the HEAD of Python 3.10

​

-------------------------------------------------------------------

Sun Aug  1 09:22:28 UTC 2021 - Dirk Müller <dmueller@suse.com>

​

- update to 4.1.2:

  * linkcheck: Disable checking automatically generated anchors on

    github.com (ex. anchors in reST/Markdown documents)

  * autodoc: Custom types using ``typing.NewType`` are not displayed well

    with the HEAD of 3.10

  * autodoc: Some objects under ``typing`` module are not displayed well

    with the HEAD of 3.10

  * autodoc: crashed if ``autodoc_class_signature = "separated"``

  * html search: html_copy_source can't control the search summaries

  * linkcheck: Failed to check anchors in github.com

​

-------------------------------------------------------------------

Sat Jul 17 13:23:38 UTC 2021 - Dirk Müller <dmueller@suse.com>

​

- update to 4.1.1:

  * sphinxcontrib-htmlhelp-2.0.0 or above

  * sphinxcontrib-serializinghtml-1.1.5 or above

  * html: HTML logo or Favicon specified as file not being found on output 

​

-------------------------------------------------------------------

Mon Jul 12 10:14:42 UTC 2021 - Martin Liška <mliska@suse.cz>

​

- Bump to 4.1.0:

  * Support jinja2-3.0

  * The ``app`` argument of ``sphinx.environment.BuildEnvironment`` becomes

    required

  * ``sphinx.application.Sphinx.html_theme``

  * ``sphinx.ext.autosummary._app``

  * ``sphinx.util.docstrings.extract_metadata()``

  * #8107: autodoc: Add ``class-doc-from`` option to :rst:dir:`autoclass`

    directive to control the content of the specific class like

    :confval:`autoclass_content`

  * #8588: autodoc: :confval:`autodoc_type_aliases` now supports dotted name. It

    allows you to define an alias for a class with module name like

    ``foo.bar.BazClass``

  * #9175: autodoc: Special member is not documented in the module

  * #9195: autodoc: The arguments of ``typing.Literal`` are wrongly rendered

  * #9185: autodoc: :confval:`autodoc_typehints` allows ``'both'`` setting to

    allow typehints to be included both in the signature and description

  * #4257: autodoc: Add :confval:`autodoc_class_signature` to separate the class

    entry and the definition of ``__init__()`` method

  * #8061, #9218: autodoc: Support variable comment for alias classes

  * #3014: autodoc: Add :event:`autodoc-process-bases` to modify the base classes

    of the class definitions

  * #9272: autodoc: Render enum values for the default argument value better

  * #9384: autodoc: ``autodoc_typehints='none'`` now erases typehints for

    variables, attributes and properties

  * #3257: autosummary: Support instance attributes for classes

  * #9358: html: Add "heading" role to the toctree items

  * #9225: html: Add span tag to the return typehint of method/function

  * #9129: html search: Show search summaries when html_copy_source = False

  * #9307: html search: Prevent corrections and completions in search field

  * #9120: html theme: Eliminate prompt characters of code-block from copyable

    text

  * #9176: i18n: Emit a debug message if message catalog file not found under

    :confval:`locale_dirs`

  * #9414: LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents

  * #9016: linkcheck: Support checking anchors on github.com

  * #9016: linkcheck: Add a new event :event:`linkcheck-process-uri` to modify

    URIs before checking hyperlinks

  * #6525: linkcheck: Add :confval:`linkcheck_allowed_redirects` to mark

    hyperlinks that are redirected to expected URLs as "working"

  * #1874: py domain: Support union types using ``|`` in info-field-list

  * #9268: py domain: :confval:`python_use_unqualified_type_names` supports type

    field in info-field-list

  * #9097: Optimize the parallel build

  * #9131: Add :confval:`nitpick_ignore_regex` to ignore nitpicky warnings using

    regular expressions

  * #9174: Add ``Sphinx.set_html_assets_policy`` to tell extensions to include

    HTML assets in all the pages. Extensions can check this via

    ``Sphinx.registry.html_assets_policy``

  * C++, add support for

    - ``inline`` variables,

    - ``consteval`` functions,

    - ``constinit`` variables,

    - ``char8_t``,

    - ``explicit(<constant expression>)`` specifier,

    - digit separators in literals, and

    - constraints in placeholder type specifiers, aka. adjective syntax

      (e.g., ``Sortable auto &v``).

  * C, add support for digit separators in literals.

  * #9166: LaTeX: support containers in LaTeX output

  * #8872: autodoc: stacked singledispatches are wrongly rendered

  * #8597: autodoc: a docsting having metadata only should be treated as

    undocumented

  * #9185: autodoc: typehints for overloaded functions and methods are inaccurate

  * #9250: autodoc: The inherited method not having docstring is wrongly parsed

  * #9283: autodoc: autoattribute directive failed to generate document for an

    attribute not having any comment

  * #9364: autodoc: single element tuple on the default argument value is wrongly

    rendered

  * #9362: autodoc: AttributeError is raised on processing a subclass of Tuple[()]

  * #9404: autodoc: TypeError is raised on processing dict-like object (not a

    class) via autoclass directive

  * #9317: html: Pushing left key causes visiting the next page at the first page

  * #9381: html: URL for html_favicon and html_log does not work

  * #9270: html theme : pyramid theme generates incorrect logo links

  * #9217: manpage: The name of manpage directory that is generated by

    :confval:`man_make_section_directory` is not correct

  * #9350: manpage: Fix font isn't reset after keyword at the top of samp role

  * #9306: Linkcheck reports broken link when remote server closes the connection

    on HEAD request

  * #9280: py domain: "exceptions" module is not displayed

  * #9418: py domain: a Callable annotation with no parameters

    (e.g. ``Callable[[], None])`` will be rendered with a bracket missing

    (``Callable[], None]``)

  * #9319: quickstart: Make sphinx-quickstart exit when conf.py already exists

  * #9387: xml: XML Builder ignores custom visitors

  * #9224: ``:param:`` and ``:type:`` fields does not support a type containing

    whitespace (ex. ``Dict[str, str]``)

  * #8945: when transforming typed fields, call the specified role instead of

    making an single xref. For C and C++, use the ``expr`` role for typed fields.

​

-------------------------------------------------------------------

Sat Jun  5 13:18:44 UTC 2021 - Martin Liška <mliska@suse.cz>

​

- Update again to 4.0.2.

​

-------------------------------------------------------------------

Wed Jun  2 16:48:48 UTC 2021 - Matej Cepl <mcepl@suse.com>

​

- Switch off the failing test_signature_annotations. It is just

  not worthy filing upstream test on the obsolete version.

​

-------------------------------------------------------------------

Wed Jun  2 13:53:05 UTC 2021 - Matej Cepl <mcepl@suse.com>

​

- Revert to 3.5.4

​

-------------------------------------------------------------------

Fri May 21 09:18:07 UTC 2021 - Martin Liška <mliska@suse.cz>

​

- Update to 4.0.2: see upstream CHANGES.

- Add texlive-tex-gyre build dependency for tests.

​

-------------------------------------------------------------------

Fri Apr 16 07:02:35 UTC 2021 - Dirk Müller <dmueller@suse.com>

​

- update to 3.5.4:

  * #9071: Restrict docutils to 0.16

  * #9078: autodoc: Async staticmethods and classmethods are considered as non

    async coroutine-functions with Python3.10

  * #8870, #9001, #9051: html theme: The style are not applied with docutils-0.17

​

-------------------------------------------------------------------

Tue Apr  6 01:32:14 UTC 2021 - Dirk Müller <dmueller@suse.com>

​

- update to 3.5.3:

  * #8959: using UNIX path separator in image directive confuses Sphinx on Windows 

​

-------------------------------------------------------------------

Tue Mar 16 10:32:34 UTC 2021 - Dirk Müller <dmueller@suse.com>

​

- update to 3.5.2:

  * #8943: i18n: Crashed by broken translation messages in ES, EL and HR

  * #8936: LaTeX: A custom LaTeX builder fails with unknown node error

  * #8952: Exceptions raised in a Directive cause parallel builds to hang

  * #8883: autodoc: AttributeError is raised on assigning __annotations__ on

    read-only class

  * #8884: html: minified js stemmers not included in the distributed package

  * #8885: html: AttributeError is raised if CSS/JS files are installed via

    :confval:`html_context`

  * #8880: viewcode: ExtensionError is raised on incremental build after

    unparsable python module found

  * LaTeX: ``multicol`` (it is anyhow a required part of the official latex2e

    base distribution)

  * Update Underscore.js to 1.12.0

  * #6550: html: The config variable ``html_add_permalinks`` is replaced by

    :confval:`html_permalinks` and :confval:`html_permalinks_icon`

  * pending_xref node for viewcode extension

  * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.anchors_ignore``

  * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.auth``

  * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken``

  * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.good``

  * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected``

  * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.rqueue``

  * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.to_ignore``

  * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.workers``

  * ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.wqueue``

  * ``sphinx.builders.linkcheck.node_line_or_0()``

  * ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``

  * ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter``

  * ``sphinx.ext.autodoc.importer.get_module_members()``

  * ``sphinx.ext.autosummary.generate._simple_info()``

  * ``sphinx.ext.autosummary.generate._simple_warn()``

  * ``sphinx.writers.html.HTMLTranslator.permalink_text``

  * ``sphinx.writers.html5.HTML5Translator.permalink_text``

  * #8022: autodoc: autodata and autoattribute directives does not show right-hand

    value of the variable if docstring contains ``:meta hide-value:`` in

    info-field-list

  * #8514: autodoc: Default values of overloaded functions are taken from actual

    implementation if they're ellipsis

  * #8775: autodoc: Support type union operator (PEP-604) in Python 3.10 or above

  * #8297: autodoc: Allow to extend :confval:`autodoc_default_options` via

    directive options

  * #8619: html: kbd role generates customizable HTML tags for compound keys

  * #8634: html: Allow to change the order of JS/CSS via ``priority`` parameter

    for :meth:`Sphinx.add_js_file()` and :meth:`Sphinx.add_css_file()`

  * #6241: html: Allow to add JS/CSS files to the specific page when an extension

    calls ``app.add_js_file()`` or ``app.add_css_file()`` on

    :event:`html-page-context` event

  * #6550: html: Allow to use HTML permalink texts via

    :confval:`html_permalinks_icon`

  * #1638: html: Add permalink icons to glossary terms

  * #8868: html search: performance issue with massive lists

  * #8867: html search: Update JavaScript stemmer code to the latest version of

    Snowball (v2.1.0)

  * #8852: i18n: Allow to translate heading syntax in MyST-Parser

  * #8649: imgconverter: Skip availability check if builder supports the image

    type

  * #8573: napoleon: Allow to change the style of custom sections using

    :confval:`napoleon_custom_styles`

  * #8004: napoleon: Type definitions in Google style docstrings are rendered as

    references when :confval:`napoleon_preprocess_types` enabled

  * #6241: mathjax: Include mathjax.js only on the document using equations

  * #8775: py domain: Support type union operator (PEP-604)

  * #8651: std domain: cross-reference for a rubric having inline item is broken

  * #7642: std domain: Optimize case-insensitive match of term

  * #8681: viewcode: Support incremental build

  * #8132: Add :confval:`project_copyright` as an alias of :confval:`copyright`

  * #207: Now :confval:`highlight_language` supports multiple languages

  * #2030: :rst:dir:`code-block` and :rst:dir:`literalinclude` supports automatic

    dedent via no-argument ``:dedent:`` option

  * C++, also hyperlink operator overloads in expressions and alias declarations.

  * #8247: Allow production lists to refer to tokens from other production groups

  * #8813: Show what extension (or module) caused it on errors on event handler

  * #8213: C++: add ``maxdepth`` option to :rst:dir:`cpp:alias` to insert nested

    declarations.

  * C, add ``noroot`` option to :rst:dir:`c:alias` to render only nested

    declarations.

  * C++, add ``noroot`` option to :rst:dir:`cpp:alias` to render only nested

    declarations.

  * #8727: apidoc: namespace module file is not generated if no submodules there

  * #741: autodoc: inherited-members doesn't work for instance attributes on super

    class

  * #8592: autodoc: ``:meta public:`` does not effect to variables

  * #8594: autodoc: empty __all__ attribute is ignored

  * #8315: autodoc: Failed to resolve struct.Struct type annotation

  * #8652: autodoc: All variable comments in the module are ignored if the module

    contains invalid type comments

  * #8693: autodoc: Default values for overloaded functions are rendered as string

  * #8134: autodoc: crashes when mocked decorator takes arguments

  * #8800: autodoc: Uninitialized attributes in superclass are recognized as

    undocumented

  * #8655: autodoc: Failed to generate document if target module contains an

    object that raises an exception on ``hasattr()``

  * #8306: autosummary: mocked modules are documented as empty page when using

    :recursive: option

  * #8232: graphviz: Image node is not rendered if graph file is in subdirectory

  * #8618: html: kbd role produces incorrect HTML when compound-key separators (-,

    + or ^) are used as keystrokes

  * #8629: html: A type warning for html_use_opensearch is shown twice

  * #8714: html: kbd role with "Caps Lock" rendered incorrectly

  * #8123: html search: fix searching for terms containing + (Requires a custom

    search language that does not split on +)

  * #8665: html theme: Could not override globaltoc_maxdepth in theme.conf

  * #8446: html: consecutive spaces are displayed as single space

  * #8745: i18n: crashes with KeyError when translation message adds a new auto

    footnote reference

  * #4304: linkcheck: Fix race condition that could lead to checking the

    availability of the same URL twice

  * #8791: linkcheck: The docname for each hyperlink is not displayed

  * #7118: sphinx-quickstart: questionare got Mojibake if libreadline unavailable

  * #8094: texinfo: image files on the different directory with document are not

    copied

  * #8782: todo: Cross references in todolist get broken

  * #8720: viewcode: module pages are generated for epub on incremental build

  * #8704: viewcode: anchors are generated in incremental build after singlehtml

  * #8756: viewcode: highlighted code is generated even if not referenced

  * #8671: :confval:`highlight_options` is not working

  * #8341: C, fix intersphinx lookup types for names in declarations.

  * C, C++: in general fix intersphinx and role lookup types.

  * #8683: :confval:`html_last_updated_fmt` does not support UTC offset (%z)

  * #8683: :confval:`html_last_updated_fmt` generates wrong time zone for %Z

  * #1112: ``download`` role creates duplicated copies when relative path is

    specified

  * #2616 (fifth item): LaTeX: footnotes from captions are not clickable,

    and for manually numbered footnotes only first one with same number is

    an hyperlink

  * #7576: LaTeX with French babel and memoir crash: "Illegal parameter number

    in definition of ``\FNH@prefntext``"

  * #8055: LaTeX (docs): A potential display bug with the LaTeX generation step

    in Sphinx (how to generate one-column index)

  * #8072: LaTeX: Directive :rst:dir:`hlist` not implemented in LaTeX

  * #8214: LaTeX: The :rst:role:`index` role and the glossary generate duplicate

    entries in the LaTeX index (if both used for same term)

  * #8735: LaTeX: wrong internal links in pdf to captioned code-blocks when

    :confval:`numfig` is not True

  * #8442: LaTeX: some indexed terms are ignored when using xelatex engine

    (or pdflatex and :confval:`latex_use_xindy` set to True) with memoir class

  * #8750: LaTeX: URLs as footnotes fail to show in PDF if originating from

    inside function type signatures

  * #8780: LaTeX: long words in narrow columns may not be hyphenated

  * #8788: LaTeX: ``\titleformat`` last argument in sphinx.sty should be

    bracketed, not braced (and is anyhow not needed) 

  * #8849: LaTex: code-block printed out of margin (see the opt-in LaTeX syntax

    boolean :ref:`verbatimforcewraps <latexsphinxsetupforcewraps>` for use via

    the :ref:`'sphinxsetup' <latexsphinxsetup>` key of ``latex_elements``)

  * #8183: LaTeX: Remove substitution_reference nodes from doctree only on LaTeX

    builds

  * #8865: LaTeX: Restructure the index nodes inside title nodes only on LaTeX

    builds

  * #8796: LaTeX: potentially critical low level TeX coding mistake has gone

    unnoticed so far

  * C, :rst:dir:`c:alias` skip symbols without explicit declarations

    instead of crashing.

  * C, :rst:dir:`c:alias` give a warning when the root symbol is not declared.

  * C, ``expr`` role should start symbol lookup in the current scope.

  * #8655: autodoc: Failed to generate document if target module contains an

    object that raises an exception on ``hasattr()``

​

-------------------------------------------------------------------

Wed Jan 13 08:15:17 UTC 2021 - Markéta Machová <mmachova@suse.com>

​

- Update to 3.4.3

  * Bugfix release, see upstream CHANGES

​

-------------------------------------------------------------------

Mon Jan 11 14:09:59 UTC 2021 - Markéta Machová <mmachova@suse.com>

​

- Do not download python (and requests) documentation in the runtime.

- Add file requests.inv

​

-------------------------------------------------------------------

Tue Dec 29 20:31:46 UTC 2020 - Dirk Müller <dmueller@suse.com>

​

- update to 3.4.1:

  * #8105: autodoc: the signature of class constructor will be shown for decorated

    classes, not a signature of decorator

  * #8119: autodoc: Allow to determine whether a member not included in

    ``__all__`` attribute of the module should be documented or not via

    :event:`autodoc-skip-member` event

  * #8219: autodoc: Parameters for generic class are not shown when super class is

    a generic class and show-inheritance option is given (in Python 3.7 or above)

  * autodoc: Add ``Documenter.config`` as a shortcut to access the config object

  * autodoc: Add Optional[t] to annotation of function and method if a default

    value equal to None is set.

  * #8209: autodoc: Add ``:no-value:`` option to :rst:dir:`autoattribute` and

    :rst:dir:`autodata` directive to suppress the default value of the variable

  * #8460: autodoc: Support custom types defined by typing.NewType

  * #8285: napoleon: Add :confval:`napoleon_attr_annotations` to merge type hints

    on source code automatically if any type is specified in docstring

  * #8236: napoleon: Support numpydoc's "Receives" section

  * #6914: Add a new event :event:`warn-missing-reference` to custom warning

    messages when failed to resolve a cross-reference

  * #6914: Emit a detailed warning when failed to resolve a ``:ref:`` reference

  * #6629: linkcheck: The builder now handles rate limits. See

    :confval:`linkcheck_retry_on_rate_limit` for details.

  * Large number of bugfixes, see included NEWS

- remove sphinx-pr8520-fix-AliasNode-copy.patch (upstream)

​

-------------------------------------------------------------------

Fri Dec  4 17:19:43 UTC 2020 - Benjamin Greiner <code@bnavigator.de>

​

- Remove unused mypy from BuildRequires in :test

- Fix the intersphinx inventory bundle for multiple python flavors

  gh#openSUSE/python-rpm-macros#66

- Fix failing graphviz dot calls by including packages for png

  and pdf formats. The png fail was masked by an incorrect use of

  a shell command chain. Fails for pdf format were in the tests.

- Add sphinx-pr8520-fix-AliasNode-copy.patch to fix failing 

  manpages build -- gh#sphinx-doc/sphinx#8520

-------------------------------------------------------------------

Thu Nov 26 09:18:00 UTC 2020 - Dirk Mueller <dmueller@suse.com>

​

- update to 3.3.1:

  * #8372: autodoc: autoclass directive became slower than Sphinx-3.2

  * #7727: autosummary: raise PycodeError when documenting python package

  * #8350: autosummary: autosummary_mock_imports causes slow down builds

  * #8364: C, properly initialize attributes in empty symbols.

  * #8399: i18n: Put system locale path after the paths specified by configuration

  * #8100: html: Show a better error message for failures on copying

  html_static_files

  * #8141: C: added a ``maxdepth`` option to :rst:dir:`c:alias` to insert

  nested declarations.

  * #8081: LaTeX: Allow to add LaTeX package via ``app.add_latex_package()`` until

  just before writing .tex file

  * #7996: manpage: Add :confval:`man_make_section_directory` to make a section

  directory on build man page

  * #8289: epub: Allow to suppress "duplicated ToC entry found" warnings from epub

  builder using :confval:`suppress_warnings`.

  * #8298: sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep` option

  * #8304: sphinx.testing: Register public markers in sphinx.testing.fixtures

  * #8051: napoleon: use the obj role for all See Also items

  * #8050: napoleon: Apply :confval:`napoleon_preprocess_types` to every field

  * C and C++, show line numbers for previous declarations when duplicates are

  detected.

  * #8183: Remove substitution_reference nodes from doctree only on LaTeX builds

  * bugfixes

  - remove sphinx-pygments-compat.patch (obsolete)

​

-------------------------------------------------------------------

Wed Nov  4 11:10:14 UTC 2020 - Benjamin Greiner <code@bnavigator.de>

​

- Fix the lang collection macro override.

  * gh#openSUSE/python-rpm-macros#66

  * gh#openSUSE/python-rpm-macros#74

​

-------------------------------------------------------------------

Tue Nov  3 19:56:15 UTC 2020 - Benjamin Greiner <code@bnavigator.de>

​

- Fix lang files collection for multiple flavors

  * gh#openSUSE/python-rpm-macros#5

  * gh#openSUSE/python-rpm-macros#66

​

-------------------------------------------------------------------

Mon Sep 28 13:45:37 UTC 2020 - Dirk Mueller <dmueller@suse.com>

​

- add sphinx-pygments-compat.patch (fix tests with newer pygments) 

​

-------------------------------------------------------------------

Tue Aug 18 14:44:04 UTC 2020 - Dirk Mueller <dmueller@suse.com>

​

- update to 3.2.1:

  * #8095: napoleon: Add :confval:`napoleon_preprocess_types` to enable the type

    preprocessor for numpy style docstrings

  * #8114: C and C++, parse function attributes after parameters and qualifiers.

  * #8074: napoleon: Crashes during processing C-ext module

  * #8088: napoleon: "Inline literal start-string without end-string" warning in

    Numpy style Parameters section

  * #8084: autodoc: KeyError is raised on documenting an attribute of the broken

    class

  * #8091: autodoc: AttributeError is raised on documenting an attribute on Python

    3.5.2

  * #8099: autodoc: NameError is raised when target code uses ``TYPE_CHECKING``

  * C++, fix parsing of template template paramters, broken by the fix of #7944

​

-------------------------------------------------------------------

Thu Aug 13 14:02:03 UTC 2020 - Dirk Mueller <dmueller@suse.com>

​

​

- update to 3.2.0:

  * #2076: autodoc: Allow overriding of exclude-members in skip-member function

  * #8034: autodoc: ``:private-member:`` can take an explicit list of member names

    to be documented

  * #2024: autosummary: Add :confval:`autosummary_filename_map` to avoid conflict

    of filenames between two object with different case

  * #8011: autosummary: Support instance attributes as a target of autosummary

    directive

  * #7849: html: Add :confval:`html_codeblock_linenos_style` to change the style

    of line numbers for code-blocks

  * #7853: C and C++, support parameterized GNU style attributes.

  * #7888: napoleon: Add aliases Warn and Raise.

  * #7690: napoleon: parse type strings and make them hyperlinks as possible.  The

    conversion rule can be updated via :confval:`napoleon_type_aliases`

  * #8049: napoleon: Create a hyperlink for each the type of parameter when

    :confval:`napoleon_use_params` is False

  * C, added :rst:dir:`c:alias` directive for inserting copies

    of existing declarations.

  * #7745: html: inventory is broken if the docname contains a space

  * #7991: html search: Allow searching for numbers

  * #7902: html theme: Add a new option :confval:`globaltoc_maxdepth` to control

    the behavior of globaltoc in sidebar

  * #7840: i18n: Optimize the dependencies check on bootstrap

  * #7768: i18n: :confval:`figure_language_filename` supports ``docpath`` token

  * #5208: linkcheck: Support checks for local links

  * #5090: setuptools: Link verbosity to distutils' -v and -q option

  * #6698: doctest: Add ``:trim-doctest-flags:`` and ``:no-trim-doctest-flags:``

    options to doctest, testcode and testoutput directives

  * #7052: add ``:noindexentry:`` to the Python, C, C++, and Javascript domains.

    Update the documentation to better reflect the relationship between this option

    and the ``:noindex:`` option.

  * #7899: C, add possibility of parsing of some pre-v3 style type directives and

    roles and try to convert them to equivalent v3 directives/roles.

    Set the new option :confval:`c_allow_pre_v3` to ``True`` to enable this.

    The warnings printed from this functionality can be suppressed by setting

    :confval:`c_warn_on_allowed_pre_v3`` to ``True``.

    The functionality is immediately deprecated.

  * #7999: C, add support for named variadic macro arguments.

  * #8071: Allow to suppress "self referenced toctrees" warning

  * #7886: autodoc: TypeError is raised on mocking generic-typed classes

  * #7935: autodoc: function signature is not shown when the function has a

    parameter having ``inspect._empty`` as its default value

  * #7901: autodoc: type annotations for overloaded functions are not resolved

  * #904: autodoc: An instance attribute cause a crash of autofunction directive

  * #1362: autodoc: ``private-members`` option does not work for class attributes

  * #7983: autodoc: Generator type annotation is wrongly rendered in py36

  * #8030: autodoc: An uninitialized annotated instance variable is not documented

    when ``:inherited-members:`` option given

  * #8032: autodoc: A type hint for the instance variable defined at parent class

    is not shown in the document of the derived class

  * #8041: autodoc: An annotated instance variable on super class is not

    documented when derived class has other annotated instance variables

  * #7839: autosummary: cannot handle umlauts in function names

  * #7865: autosummary: Failed to extract summary line when abbreviations found

  * #7866: autosummary: Failed to extract correct summary line when docstring

    contains a hyperlink target

  * #7469: autosummary: "Module attributes" header is not translatable

  * #7940: apidoc: An extra newline is generated at the end of the rst file if a

    module has submodules 

  * #4258: napoleon: decorated special methods are not shown

  * #7799: napoleon: parameters are not escaped for combined params in numpydoc

  * #7780: napoleon: multiple paramaters declaration in numpydoc was wrongly

    recognized when napoleon_use_params=True

  * #7715: LaTeX: ``numfig_secnum_depth > 1`` leads to wrong figure links

  * #7846: html theme: XML-invalid files were generated

  * #7894: gettext: Wrong source info is shown when using rst_epilog

  * #7691: linkcheck: HEAD requests are not used for checking

  * #4888: i18n: Failed to add an explicit title to ``:ref:`` role on translation

  * #7928: py domain: failed to resolve a type annotation for the attribute

  * #8008: py domain: failed to parse a type annotation containing ellipsis

  * #7994: std domain: option directive does not generate old node_id compatible

    with 2.x or older

  * #7968: i18n: The content of ``math`` directive is interpreted as reST on

    translation

  * #7768: i18n: The ``root`` element for :confval:`figure_language_filename` is

    not a path that user specifies in the document

  * #7993: texinfo: TypeError is raised for nested object descriptions

  * #7993: texinfo: a warning not supporting desc_signature_line node is shown

  * #7869: :rst:role:`abbr` role without an explanation will show the explanation

    from the previous abbr role

  * #8048: graphviz: graphviz.css was copied on building non-HTML document

  * C and C++, removed ``noindex`` directive option as it did

    nothing.

  * #7619: Duplicated node IDs are generated if node has multiple IDs

  * #2050: Symbols sections are appeared twice in the index page

  * #8017: Fix circular import in sphinx.addnodes

  * #7986: CSS: make "highlight" selector more robust

  * #7944: C++, parse non-type template parameters starting with

    a dependent qualified name.

  * C, don't deepcopy the entire symbol table and make a mess every time an

    enumerator is handled.

​

-------------------------------------------------------------------

Thu Jul 16 12:52:54 UTC 2020 - Matej Cepl <mcepl@suse.com>

​

- In the new multiversion world, python*.inv is in python3.8

  directory not python3.

​

-------------------------------------------------------------------

Sat Jul 11 18:49:26 UTC 2020 - Arun Persaud <arun@gmx.de>

​

- update to version 3.1.2:

  * Incompatible changes

    + #7650: autodoc: the signature of base function will be shown for

       decorated functions, not a signature of decorator

  * Bugs fixed

    + #7844: autodoc: Failed to detect module when relative module

       name given

    + #7856: autodoc: AttributeError is raised when non-class object

       is given to the autoclass directive

    + #7850: autodoc: KeyError is raised for invalid mark up when

       autodoc_typehints is 'description'

    + #7812: autodoc: crashed if the target name matches to both an

       attribute and module that are same name

    + #7650: autodoc: function signature becomes "(*args, **kwargs)"

       if the function is decorated by generic decorator

    + #7812: autosummary: generates broken stub files if the target

       code contains an attribute and module that are same name

    + #7806: viewcode: Failed to resolve viewcode references on 3rd

       party builders

    + #7838: html theme: List items have extra vertical space

    + #7878: html theme: Undesired interaction between "overflow" and

       "float"

​

- changes from version 3.1.1:

  * Incompatible changes

    + #7808: napoleon: a type for attribute are represented as typed

       field

  * Features added

    + #7807: autodoc: Show detailed warning when type_comment is

       mismatched with its signature

  * Bugs fixed

    + #7808: autodoc: Warnings raised on variable and attribute type

       annotations

    + #7802: autodoc: EOFError is raised on parallel build

    + #7821: autodoc: TypeError is raised for overloaded C-ext

       function

    + #7805: autodoc: an object which descriptors returns is

       unexpectedly documented

    + #7807: autodoc: wrong signature is shown for the function using

       contextmanager

    + #7812: autosummary: generates broken stub files if the target

       code contains an attribute and module that are same name

    + #7808: napoleon: Warnings raised on variable and attribute type

       annotations

    + #7811: sphinx.util.inspect causes circular import problem

​

- changes from version 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