Path to this page:
Subject: CVS commit: pkgsrc/textproc/py-sphinx
From: Adam Ciarcinski
Date: 2022-10-25 20:36:42
Message id: 20221025183642.78254FA90@cvs.NetBSD.org
Log Message:
py-sphinx: updated to 5.3.0
Release 5.3.0 (released Oct 16, 2022)
=====================================
Features added
--------------
* LaTeX: add :confval:`latex_table_style` and support the
``'booktabs'``, ``'borderless'``, and ``'colorrows'`` styles.
* One can cross-reference including an option value like \
``:option:`--module=foobar```,
``:option:`--module[=foobar]``` or ``:option:`--module foobar```.
Patch by Martin Liska.
* autosectionlabel: Record the generated section label to the debug log.
* Correctly URI-escape image filenames.
* domains: Allow sections in all the content of all object description
directives (e.g. :rst:dir:`py:function`). Patch by Adam Turner
Release 5.2.3 (released Sep 30, 2022)
=====================================
* Fix base64 image embedding in ``sphinx.ext.imgmath``
* Add ``:nocontentsentry:`` flag and global domain table of contents
entry control option. Patch by Adam Turner
Release 5.2.2 (released Sep 27, 2022)
=====================================
* Restore link targets for autodoc modules to the top of content.
Patch by Dominic Davis-Foster.
Release 5.2.1 (released Sep 25, 2022)
=====================================
Bugs fixed
----------
* Always normalise the ``pycon3`` lexer to ``pycon``.
* Fix using ``sphinx.ext.autosummary`` with modules containing titles in the
module-level docstring.
Release 5.2.0.post0 (released Sep 24, 2022)
===========================================
* Recreated source tarballs for Debian maintainers.
Release 5.2.0 (released Sep 24, 2022)
=====================================
Dependencies
------------
* Sphinx now uses declarative metadata with ``pyproject.toml`` to
create packages, using PyPA's ``flit`` project as a build backend. Patch by
Adam Turner.
Deprecated
----------
* Support for HTML 4 output. Patch by Adam Turner.
Features added
--------------
* napoleon: Add support for docstring types using 'of', like
``type of type``. Example: ``tuple of int``.
* C++, support requires clauses not just between the template
parameter lists and the declaration.
* linkcheck: Check the source URL of raw directives that use the ``url``
option.
* Allow :rst:role:`ref` role to be used with definitions and fields.
* HTML Search: Increase priority for full title and
subtitle matches in search results
* HTML Search: Save search result score to the HTML element for debugging
* Make toctree accept 'genindex', 'modindex' and 'search' docnames
* Add domain objects to the table of contents. Patch by Adam Turner
* HTML Search: Include explicit :rst:dir:`index` directive index entries
in the search index and search results. Patch by Adam Turner
* imgmath: Allow embedding images in HTML as base64
* HTML Search: Use browser localstorage for highlight control, stop
storing highlight parameters in URL query strings. Patch by Adam Turner.
Bugs fixed
----------
* LaTeX: 5.1.0 has made the 'sphinxsetup' ``verbatimwithframe=false``
become without effect.
* C++, ensure consistent non-specialization template argument
representation.
* C++, fix parsing of certain non-type template parameter packs.
* Revert 10520: "Fix" use of sidebar classes in ``agogo.css_t``
Release 5.1.1 (released Jul 26, 2022)
=====================================
Bugs fixed
----------
* Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean``
iterator implementation.
* Restore compatability with third-party builders.
Release 5.1.0 (released Jul 24, 2022)
=====================================
Dependencies
------------
* Support `Docutils 0.19`_. Patch by Adam Turner.
Deprecated
----------
* Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``.
Patch by Adam Turner.
* Deprecated ``sphinx.ext.napoleon.iterators``.
Features added
--------------
* html theme: Allow specifying multiple CSS files through the ``stylesheet``
setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings.
* std domain: Add support for emphasising placeholders in :rst:dir:`option`
directives through a new :confval:`option_emphasise_placeholders` configuration
option.
* std domain: Use the repr of some variables when displaying warnings,
making whitespace issues easier to identify.
* quickstart: Reduce content in the generated ``conf.py`` file. Patch by
Pradyun Gedam.
* 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.
* LaTeX: Explain non-standard encoding in LatinRules.xdy
* 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.
* config: Add ``include_patterns`` as the opposite of ``exclude_patterns``.
Patch by Adam Turner.
Bugs fixed
----------
* HTML Theme: field term colons are doubled if using Docutils 0.18+
* Build failure if Docutils version is 0.18 (not 0.18.1) due
to missing ``Node.findall()``
* LaTeX: build error if highlighting inline code role in figure caption
* Make -P (pdb) option work better with exceptions triggered from events
* py domain: Fix spurious whitespace in unparsing various operators (``+``,
``-``, ``~``, and ``**``). Patch by Adam Turner.
* 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
* HTML Theme: Fix use of sidebar classes in ``agogo.css_t``.
* HTML Theme: Fix inclusion of hidden toctrees in the agogo theme.
* HTML Theme: Fix enable_search_shortcuts does not work
* LaTeX: Text can fall out of code-block at end of page and leave artifact
on next page
* 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
* LaTeX: framed coloured boxes in highlighted code (e.g. highlighted
diffs using Pygments style ``'manni'``) inherit thickness of code-block frame
* LaTeX: Only one ``\label`` is generated for ``desc_signature`` node
even if it has multiple node IDs
* i18n: UnboundLocalError is raised on translating raw directive
* py domain: Fix warning for duplicate Python references when
using ``:any:`` and autodoc.
* HTML Search: fix minor summary issues.
Files: