chore(deps): update documentation dependencies #745

renovate · 2024-05-31T22:00:02Z

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
Sphinx (changelog)	`==7.2.6` -> `==7.3.7`
furo	`==2024.1.29` -> `==2024.5.6`
sphinx-autobuild (changelog)	`==2024.2.4` -> `==2024.4.16`
sphinx-autodoc-typehints (changelog)	`==2.0.1` -> `==2.2.2`
sphinx-design	`==0.5.0` -> `==0.6.0`
sphinx_design	`==0.5.0` -> `==0.6.0`

Release Notes

sphinx-doc/sphinx (Sphinx)

`v7.3.7`

Compare Source

=====================================

Bugs fixed

#12299: Defer loading themes defined via entry points until
their explicit use by the user or a child theme.
Patch by Adam Turner.
#12305: Return the default value for theme.get_config() with
an unsupported theme configuration section.
Patch by Adam Turner.

`v7.3.6`

Compare Source

=====================================

Bugs fixed

#12295: Re-export all AST types in the C and C++ domains.
Patch by Adam Turner.
#12295: Re-export various objects from sphinx.domains.python._annotations
in sphinx.domains.python.
Patch by Jacob Chesslo and Adam Turner.

`v7.3.5`

Compare Source

=====================================

Bugs fixed

#12295: Re-export various objects from sphinx.domains.python._object
in sphinx.domains.python.
Patch by Jacob Chesslo and Adam Turner.

`v7.3.4`

Compare Source

=====================================

Bugs fixed

Handle cases when Any is not an instance of type.
Patch by Adam Turner.

`v7.3.3`

Compare Source

=====================================

Bugs fixed

#12290: Fix a false-positive warning when setting a configuration value
with Any as the valid type to a type other than the value's default.
Patch by Adam Turner.

`v7.3.2`

Compare Source

=====================================

Bugs fixed

Preload all themes defined via entry points.
Patch by Adam Turner.
Fix a bad interaction between the 'Furo' theme and the new-style for
configuration values.
Patch by Adam Turner.

`v7.3.1`

Compare Source

=====================================

Dependencies

Require tomli on Python 3.10 and earlier.
Patch by Adam Turner.

`v7.3.0`

Compare Source

=====================================

Dependencies

#11858: Increase the minimum supported version of Alabaster to 0.7.14.
Patch by Adam Turner.
#11411: Support Docutils 0.21_. Patch by Adam Turner.

.. _Docutils 0.21: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09
#12012: Use types-docutils instead of docutils-stubs.

Deprecated

#11693: Support for old-style :file:Makefile and :file:make.bat output
in :program:sphinx-quickstart, and the associated options :option:!-M,
:option:!-m, :option:!--no-use-make-mode, and :option:!--use-make-mode.
#11285: Direct access to :attr:!sphinx.testing.util.SphinxTestApp._status
or :attr:!sphinx.testing.util.SphinxTestApp._warning is deprecated. Use
the public properties :attr:!sphinx.testing.util.SphinxTestApp.status
and :attr:!sphinx.testing.util.SphinxTestApp.warning instead.
Patch by Bénédikt Tran.
tests: :func:!sphinx.testing.util.strip_escseq is deprecated in favour of
:func:!sphinx.util.console.strip_colors.
Patch by Bénédikt Tran.

Features added

#12265: Support theme configuration via theme.toml.
#11701: HTML Search: Adopt the new \<search\>_ element.
Patch by Bénédikt Tran.

.. _\<search\>: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/search
#11776: Add long option names to sphinx-build.
Patch by Hugo van Kemenade, Adam Turner, Bénédikt Tran, and Ezio Melotti.
Organise the sphinx-build options into groups.
Patch by Adam Turner.
#11855: Defer computation of configuration values.
Patch by Adam Turner.
Add :no-search: as an alias of the :nosearch: metadata field.
Patch by Adam Turner.
#11803: autodoc: Use an overriden __repr__() function in an enum,
if defined. Patch by Shengyu Zhang.
#11825: Allow custom targets in the manpage role.
Patch by Nicolas Peugnet.
#11892: Improved performance when resolving cross references in the C++ domain.
Patch by Rouslan Korneychuk.
#11905: Add a :rst:dir:versionremoved directive.
Patch by Hugo van Kemenade, Adam Turner, and C.A.M. Gerlach.
#11981: Improve rendering of signatures using slice syntax,
e.g., def foo(arg: np.float64[:,:]) -> None: ....
The manpage builder now adds OSC 8_ anchors to hyperlinks, using
the groff_ device control command.

.. _OSC 8: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
.. _groff: https://lists.gnu.org/archive/html/groff/2021-10/msg00000.html
#11015: Change the text of the :rst:dir:versionadded directive from
New in [...] to Added in [...].
Patch by Bénédikt Tran.
#12131: Added :confval:show_warning_types configuration option.
Patch by Chris Sewell.
#12193: Improve external warnings for unknown roles.
In particular, suggest related role names if an object type is mistakenly used.
Patch by Chris Sewell.
Add public type alias :class:sphinx.util.typing.ExtensionMetadata.
This can be used by extension developers
to annotate the return type of their setup function.
Patch by Chris Sewell.

Bugs fixed

#11668: Raise a useful error when theme.conf is missing.
Patch by Vinay Sajip.
#11622: Ensure that the order of keys in searchindex.js is deterministic.
Patch by Pietro Albini.
#11617: ANSI control sequences are stripped from the output when writing to
a warnings file with :option:-w <sphinx-build -w>.
Patch by Bénédikt Tran.
#11666: Skip all hidden directories in CatalogRepository.pofiles.
Patch by Aryaz Eghbali.
#9686: html builder: Fix MathJax lazy loading when equations appear in titles.
Patch by Bénédikt Tran.
#11483: singlehtml builder: Fix MathJax lazy loading when the index does not
contain any math equations.
Patch by Bénédikt Tran.
#11697: HTML Search: add 'noindex' meta robots tag.
Patch by James Addison.
#11678: Fix a possible ZeroDivisionError in sphinx.ext.coverage.
Patch by Stephen Finucane.
#11756: LaTeX: build error with recent TeXLive due to missing substitutefont
package (triggered if using fontenc with T2A option and document
language is not a Cyrillic one).
Patch by Jean-François B.
#11675: Fix rendering of progression bars in environments that do not support
ANSI control sequences.
Patch by Bénédikt Tran.
#11861: Whitelist more types with an incorrect __module__ attribute.
Patch by Adam Turner.
#11715: Apply tls_verify and tls_cacerts config to
ImageDownloader.
Patch by Nick Touran.
Allow hyphens in group names for :rst:dir:productionlist cross-references.
Patch by Adam Turner.
#11433: Added the :confval:linkcheck_allow_unauthorized configuration option.
Set this option to False to report HTTP 401 (unauthorized) server
responses as broken.
Patch by James Addison.
#11868: linkcheck: added a distinct timeout reporting status code.
This can be enabled by setting :confval:linkcheck_report_timeouts_as_broken
to False.
Patch by James Addison.
#11869: Refresh the documentation for the linkcheck_timeout setting.
Patch by James Addison.
#11874: Configure a default 30-second value for linkcheck_timeout.
Patch by James Addison.
#11886: Print the Jinja2 template path chain in TemplateNotFound exceptions.
Patch by Colin Marquardt.
#11598: Do not use query components in URLs for assets in EPUB rendering.
Patch by David Runge.
#11904: Support unary subtraction when parsing annotations.
Patch by James Addison.
#11925: Blacklist the sphinxprettysearchresults extension; the functionality
it provides was merged into Sphinx v2.0.0.
Patch by James Addison.
#11917: Fix rendering of annotated inherited members for Python 3.9.
Patch by Janet Carson.
#11935: C Domain: Fix namespace-pop context.
Patch by Frank Dana.
#11923: Avoid zombie processes when parallel builds fail.
Patch by Felix von Drigalski.
#11353: Support enumeration classes inheriting from mixin or data types.
Patch by Bénédikt Tran.
#11962: Fix target resolution when using :paramtype: fields.
Patch by Bénédikt Tran.
#11944: Use anchor in search preview.
Patch by Will Lachance.
#12008: Fix case-sensitive lookup of std:label names in intersphinx inventory.
Patch by Michael Goerz.
#11958: HTML Search: Fix partial matches overwriting full matches.
Patch by William Lachance.
#11959: Fix multiple term matching when word appears in both title and document.
Patch by Will Lachance.
#11474: Fix doctrees caching causing files not be rebuilt in some cases,
e.g., when :confval:numfig is True.
Patch by Bénédikt Tran.
#11278: autodoc: Fix rendering of :class:functools.singledispatchmethod
combined with :func:@classmethod <classmethod>.
Patch by Bénédikt Tran.
#11894: Do not add checksums to css files if building using the htmlhelp builder.
Patch by reduerK akiM.
#12052: Remove <script> and <style> tags from the content of search result
summary snippets.
Patch by James Addison.
#11578: HTML Search: Order non-main index entries after other results.
Patch by Brad King.
#12147: autosummary: Fix a bug whereby the wrong file extension
may be used,
when multiple suffixes are specified in :confval:source_suffix.
Patch by Sutou Kouhei.
#10786: improve the error message when a file to be copied (e.g., an asset)
is removed during Sphinx execution.
Patch by Bénédikt Tran.
#12040: HTML Search: Ensure that document titles that are partially-matched by
the user search query are included in search results.
Patch by James Addison.
#11970: singlehtml builder: make target URIs to be same-document references in
the sense of :rfc:RFC 3986, §4.4 <3986#section-4.4>, e.g., index.html#foo
becomes #foo. Patch by Eric Norige.
#12271: Partially revert Docutils' r9562__ to fix EPUB files.
Patch by Adam Turner.

__ https://sourceforge.net/p/docutils/code/9562/
#12253: Escape reserved path characters in the remote images post-transform
download cache.
Patch by James Addison and Adam Turner.

Testing

Reorganise tests into directories.
Patch by Adam Turner.
Clean up global state in SphinxTestApp.
Patch by Adam Turner.
#11285: :func:!pytest.mark.sphinx and :class:!sphinx.testing.util.SphinxTestApp
accept warningiserror, keep_going and verbosity as keyword arguments.
Patch by Bénédikt Tran.
#11285: :class:!sphinx.testing.util.SphinxTestApp status and warning
arguments are checked to be :class:io.StringIO objects (the public API
incorrectly assumed this without checking it).
Patch by Bénédikt Tran.
Report the result of test_run_epubcheck as skipped instead of
success when either Java or epubcheck are not available.
Use dynamic allocation of unused port numbers for the test HTTP(S) servers.
As a side-effect, this removes the need for test server lockfiles,
meaning that any remaining tests/test-server.lock files can safely be
deleted.

pradyunsg/furo (furo)

`v2024.5.6`

Compare Source

`v2024.4.27`

Compare Source

sphinx-doc/sphinx-autobuild (sphinx-autobuild)

`v2024.4.16`

Compare Source

`v2024.4.13`

Compare Source

tox-dev/sphinx-autodoc-typehints (sphinx-autodoc-typehints)

`v2.2.2`

Compare Source

What's Changed

Fix for Issue #384: typehints_defaults = "braces-after" fails for a multiline :param: entry by @tikuma-lsuhsc in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/464

Full Changelog: tox-dev/sphinx-autodoc-typehints@2.2.1...2.2.2

executablebooks/sphinx-design (sphinx-design)

`v0.6.0`

Compare Source

Dependencies

⬆️ Python v3.9-3.12 by {user}chrisjsewell in {pr}186
⬆️ Octicon icons to v19.8.0 by {user}ffvpor in {pr}171

New

✨ Create custom directives

You can use the sd_custom_directives configuration option in your conf.py to add custom directives, with default option values:

sd_custom_directives = {
  "dropdown-syntax": {
    "inherit": "dropdown",
    "argument": "Syntax",
    "options": {
      "color": "primary",
      "icon": "code",
    },
  }
}

The key is the new directive name to add, and the value is a dictionary with the following keys:

inherit: The directive to inherit from (e.g. dropdown)
argument: The default argument (optional, only for directives that take a single argument)
options: A dictionary of default options for the directive (optional)

by {user}chrisjsewell in {pr}194

✨ sync tabs by URL query parameters

Synchronised tabs can now be selected by adding a query parameter to the URL, for that sync-group, such as ?code=python for

.. tab-set-code::

    .. literalinclude:: snippet.py
        :language: python

    .. literalinclude:: snippet.js
        :language: javascript

The last selected tab key, per group, is also persisted to SessionStorage

by {user}mikemckiernan and {user}chrisjsewell in {pr}196

Improve

👌 Use reference name by default for internal link cards by {user}gabalafou in {pr}183
👌 Improve specificity of JS function name by {user}danirus in {pr}153
👌 Remove duplicate CSS hashing for sphinx >= 7.1 by {user}chrisjsewell in {pr}193

👌 Improve `dropdown` title bar

There are three visible changes:

The "default" behaviour of the right chevron is to go from right-facing (closed) to down-facing (open), instead of down-facing (closed) to up-facing (open). There is also a rotate transition on opening/closing.
The old default behaviour can be retained by using the new :chevron: down-up directive option.
The prefix icon (optional), title text, and chevron state icon are now all better aligned
The top/bottom padding is now 0.5em instead of 1em

The PR also introduces three new CSS variables to control font sizes of the dropdown:

--sd-fontsize-tabs-label: 1rem;
--sd-fontsize-dropdown-title: 1rem;
--sd-fontweight-dropdown-title: 700;

Internally, the HTML / CSS is changed, such that the title is now an inline-flex box, with three columns arranged with justify-content: space-between:

icon (optional)	text (`flex-grow: 1`)	state chevron

Also, the state chevron was previously two distinct SVGs (with one hidden), but now is one that get rotated on open/close.

by {user}chrisjsewell in {pr}192

Fix

🐛 Fix tab-item label with nested syntax by {user}Praecordi in {pr}135
🐛 Fix do not close input tag by {user}chrisjsewell in {pr}195

Internal

📚 Update theme versions by {user}chrisjsewell in {pr}189
📚 Make octicon list a table by {user}chrisjsewell in {pr}188
📚 Add sphinx-immaterial to doc theme builds by {user}chrisjsewell in {pr}190
📚 Change syntax dropdown color by {user}chrisjsewell in {pr}191
🔧 Add FIPS compliant flag to md5 call by {user}gabor-varga in {pr}162
🔧 define build.os for RTD to fix build by {user}sciencewhiz in {pr}176
🔧 Move to ruff by {user}chrisjsewell in {pr}185

Full Changelog: executablebooks/sphinx-design@v0.5.0...v0.6.0

Configuration

📅 Schedule: Branch creation - "every weekend" in timezone Etc/UTC, Automerge - "every weekend" in timezone Etc/UTC.

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

renovate bot added the dependencies label May 31, 2024

renovate bot force-pushed the renovate/doc-dependencies branch from e2727a8 to b943c13 Compare June 6, 2024 07:45

lengau approved these changes Jun 12, 2024

View reviewed changes

renovate bot force-pushed the renovate/doc-dependencies branch from b943c13 to c7da312 Compare June 12, 2024 14:16

renovate bot force-pushed the renovate/doc-dependencies branch from c7da312 to 03882f7 Compare June 21, 2024 15:08

sergiusens approved these changes Jun 21, 2024

View reviewed changes

renovate bot force-pushed the renovate/doc-dependencies branch from 03882f7 to 488fc1e Compare June 23, 2024 17:13

sergiusens force-pushed the renovate/doc-dependencies branch from 488fc1e to 57d9eb3 Compare June 24, 2024 14:00

chore(deps): update documentation dependencies

40ba939

renovate bot force-pushed the renovate/doc-dependencies branch from 57d9eb3 to 40ba939 Compare June 24, 2024 15:28

sergiusens merged commit 84e9616 into main Jun 24, 2024
11 checks passed

sergiusens deleted the renovate/doc-dependencies branch June 24, 2024 23:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(deps): update documentation dependencies #745

chore(deps): update documentation dependencies #745

renovate bot commented May 31, 2024 •

edited

Loading

chore(deps): update documentation dependencies #745

chore(deps): update documentation dependencies #745

Conversation

renovate bot commented May 31, 2024 • edited Loading

Release Notes

Bugs fixed

Bugs fixed

Bugs fixed

Bugs fixed

Bugs fixed

Bugs fixed

Dependencies

Dependencies

Deprecated

Features added

Bugs fixed

Testing

What's Changed

What's Changed

What's Changed

New Contributors

What's Changed

Dependencies

New

✨ Create custom directives

✨ sync tabs by URL query parameters

Improve

👌 Improve dropdown title bar

Fix

Internal

Configuration

renovate bot commented May 31, 2024 •

edited

Loading

👌 Improve `dropdown` title bar