sphinx-7.3.7

[Bruce Dubbs]

New minor version.

[Bruce Dubbs]

Release 7.3.5 (released Apr 17, 2024)

• Re-export various objects from sphinx.domains.python._object in sphinx.domains.python.

Release 7.3.4 (released Apr 17, 2024)

• Handle cases when Any is not an instance of type.

Release 7.3.3 (released Apr 17, 2024)

• 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.

Release 7.3.2 (released Apr 17, 2024)

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

Release 7.3.1 (released Apr 17, 2024)

• Require tomli on Python 3.10 and earlier.

Release 7.3.0 (released Apr 16, 2024)

• Increase the minimum supported version of Alabaster to 0.7.14.
• Support Docutils 0.21_.
• Use types-docutils instead of docutils-stubs.

Deprecated

• 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.
• 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.
• tests: :func:!sphinx.testing.util.strip_escseq is deprecated in favour of :func:!sphinx.util.console.strip_colors.

Features added

• Support theme configuration via theme.toml.
• HTML Search: Adopt the new \<search\>_ element.
• Add long option names to sphinx-build.
• Organise the sphinx-build options into groups.
• Defer computation of configuration values.
• Add :no-search: as an alias of the :nosearch: metadata field.
• autodoc: Use an overriden repr() function in an enum, if defined.
• Allow custom targets in the manpage role.
• Improved performance when resolving cross references in the C++ domain.
• Add a :rst:dir:`versionremoved` directive.
• Improve rendering of signatures using slice syntax,
• The manpage builder now adds OSC 8_ anchors to hyperlinks, using the groff_ device control command.
• Change the text of the :rst:dir:`versionadded` directive from New in [...] to Added in [...].
• Added :confval:show_warning_types configuration option.
• Improve external warnings for unknown roles. In particular, suggest related role names if an object type is mistakenly used.
• 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.

Testing

• Reorganise tests into directories.
• Clean up global state in SphinxTestApp.
• :func:!pytest.mark.sphinx and :class:!sphinx.testing.util.SphinxTestApp accept *warningiserror*, *keep_going* and *verbosity* as keyword arguments.
• :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).
• 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.

[Douglas R. Reno]

Now Sphinx-7.3.6.

There's some serious problems with the tests and with the package at runtime right now. They've put out 6 releases in the past 24 hours.

The final test results for me are:

505 failed, 1630 passed, 9 skipped, 35 warnings in 192.35s (0:03:12)

The bulk majority of these test failures are due to files not being found and a large amount of assertion failures.

Note that the tests also need 'defusedxml' now

[Bruce Dubbs]

Now at version 7.3.7, but the tests are quite problematic:

==== 421 failed, 1703 passed, 20 skipped, 35 warnings in 150.50s (0:02:30) =====
155.9 Elapsed Time -  sphinx-7.3.7
 
md5sum : 4c4f1e3e6a456a64712ff406680338ab  /usr/src/python-modules/sphinx/sphinx-7.3.7.tar.gz
6932 /usr/src/python-modules/sphinx/sphinx-7.3.7.tar.gz SIZE (6.769 MB)
53544 kilobytes BUILD SIZE (52.289 MB)
SBU=1.658

For tests I am using:

python3 -m venv --system-site-packages testenv &&
    source testenv/bin/activate                    &&
    pip3 install html5lib  defusedxml              &&
    python3 /usr/bin/pytest
    deactivate

Note that I had to add the module 'defusedxml' to get the tests to run.

[Bruce Dubbs]

OK. After reviewing my build log I saw that the alabaser module was out of date. Upgrading that fixed the tests:

========== 2124 passed, 20 skipped, 35 warnings in 123.27s (0:02:03) ===========

md5sum : 4c4f1e3e6a456a64712ff406680338ab  /usr/src/python-modules/sphinx/sphinx-7.3.7.tar.gz
6932 /usr/src/python-modules/sphinx/sphinx-7.3.7.tar.gz SIZE (6.769 MB)
53484 kilobytes BUILD SIZE (52.230 MB)
SBU=1.367

[Bruce Dubbs]

Fixed at commits

cabe460fd3 Update to alabaster-0.7.16 (Python module).
5311f0b9f9 Update to sphinxcontrib_applehelp-1.0.8 (Python module).
6cbba3e466 Update to sphinx-7.3.7 (Python module).