2023-11-07 23:38:10 by Thomas Klausner | Files touched by this commit (112) |
Log message:
*: latest py-sphinx only support Python 3.9+
|
2023-11-07 23:27:10 by Thomas Klausner | Files touched by this commit (3) | |
Log message:
py-sphinx: update to 7.2.6.
Release 7.2.6 (released Sep 13, 2023)
=====================================
Bugs fixed
----------
* #11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES` environment variable,
which if set reloads modules when using autodoc with ``TYPE_CHECKING = True``.
Patch by Matt Wozniski and Adam Turner.
* #11679: Use :py:func:`importlib.reload` to reload modules in autodoc.
Patch by Matt Wozniski and Adam Turner.
Release 7.2.5 (released Aug 30, 2023)
=====================================
Bugs fixed
----------
* #11645: Fix a regression preventing autodoc from importing modules within
packages that make use of ``if typing.TYPE_CHECKING:`` to guard circular
imports needed by type checkers.
Patch by Matt Wozniski.
* #11634: Fixed inheritance diagram relative link resolution
for sibling files in a subdirectory.
Patch by Albert Shih.
* #11659: Allow ``?config=...`` in :confval:`mathjax_path`.
* #11654: autodoc: Fail with a more descriptive error message
when an object claims to be an instance of ``type``,
but is not a class.
Patch by James Braza.
* 11620: Cease emitting :event:`source-read` events for files read via
the :dudir:`include` directive.
* 11620: Add a new :event:`include-read` for observing and transforming
the content of included files via the :dudir:`include` directive.
* #11627: Restore support for copyright lines of the form ``YYYY``
when ``SOURCE_DATE_EPOCH`` is set.
Release 7.2.4 (released Aug 28, 2023)
=====================================
Bugs fixed
----------
* #11618: Fix a regression in the MoveModuleTargets transform,
introduced in #10478 (#9662).
* #11649: linkcheck: Resolve hanging tests for timezones west of London
and incorrect conversion from UTC to offsets from the UNIX epoch.
Patch by Dmitry Shachnev and Adam Turner.
Release 7.2.3 (released Aug 23, 2023)
=====================================
Dependencies
------------
* #11576: Require sphinxcontrib-serializinghtml 1.1.9.
Bugs fixed
----------
* Fix regression in ``autodoc.Documenter.parse_name()``.
* Fix regression in JSON serialisation.
* #11543: autodoc: Support positional-only parameters in ``classmethod`` methods
when ``autodoc_preserve_defaults`` is ``True``.
* Restore support string methods on path objects.
This is deprecated and will be removed in Sphinx 8.
Use :py:func:`os.fspath` to convert :py:class:`~pathlib.Path` objects to strings,
or :py:class:`~pathlib.Path`'s methods to work with path objects.
Release 7.2.2 (released Aug 17, 2023)
=====================================
Bugs fixed
----------
* Fix the signature of the ``StateMachine.insert_input()`` patch,
for when calling with keyword arguments.
* Fixed membership testing (``in``) for the :py:class:`str` interface
of the asset classes (``_CascadingStyleSheet`` and ``_JavaScript``),
which several extensions relied upon.
* Fixed a type error in ``SingleFileHTMLBuilder._get_local_toctree``,
``includehidden`` may be passed as a string or a boolean.
* Fix ``:noindex:`` for ``PyModule`` and ``JSModule``.
Release 7.2.1 (released Aug 17, 2023)
=====================================
Bugs fixed
----------
* Restored the the :py:class:`str` interface of the asset classes
(``_CascadingStyleSheet`` and ``_JavaScript``), which several extensions \
relied upon.
This will be removed in Sphinx 9.
* Restored calls to ``Builder.add_{css,js}_file()``,
which several extensions relied upon.
* Restored the private API ``TocTree.get_toctree_ancestors()``,
which several extensions relied upon.
Release 7.2.0 (released Aug 17, 2023)
=====================================
Dependencies
------------
* #11511: Drop Python 3.8 support.
* #11576: Require Pygments 2.14 or later.
Deprecated
----------
* #11512: Deprecate ``sphinx.util.md5`` and ``sphinx.util.sha1``.
Use ``hashlib`` instead.
* #11526: Deprecate ``sphinx.testing.path``.
Use ``os.path`` or ``pathlib`` instead.
* #11528: Deprecate ``sphinx.util.split_index_msg`` and ``sphinx.util.split_into``.
Use ``sphinx.util.index_entries.split_index_msg`` instead.
* Deprecate ``sphinx.builders.html.Stylesheet``
and ``sphinx.builders.html.Javascript``.
Use ``sphinx.application.Sphinx.add_css_file()``
and ``sphinx.application.Sphinx.add_js_file()`` instead.
* #11582: Deprecate ``sphinx.builders.html.StandaloneHTMLBuilder.css_files`` and
``sphinx.builders.html.StandaloneHTMLBuilder.script_files``.
Use ``sphinx.application.Sphinx.add_css_file()``
and ``sphinx.application.Sphinx.add_js_file()`` instead.
* #11459: Deprecate ``sphinx.ext.autodoc.preserve_defaults.get_function_def()``.
Patch by Bénédikt Tran.
Features added
--------------
* #11526: Support ``os.PathLike`` types and ``pathlib.Path`` objects
in many more places.
* #5474: coverage: Print summary statistics tables.
Patch by Jorge Leitao.
* #6319: viewcode: Add :confval:`viewcode_line_numbers` to control
whether line numbers are added to rendered source code.
Patch by Ben Krikler.
* #9662: Add the ``:no-typesetting:`` option to suppress textual output
and only create a linkable anchor.
Patch by Latosha Maltba.
* #11221: C++: Support domain objects in the table of contents.
Patch by Rouslan Korneychuk.
* #10938: doctest: Add :confval:`doctest_show_successes` option.
Patch by Trey Hunner.
* #11533: Add ``:no-index:``, ``:no-index-entry:``, and ``:no-contents-entry:``.
* #11572: Improve ``debug`` logging of reasons why files are detected as out of
date.
Patch by Eric Larson.
* #10678: Emit :event:`source-read` events for files read via
the :dudir:`include` directive.
Patch by Halldor Fannar.
* #11570: Use short names when using :pep:`585` built-in generics.
Patch by Riccardo Mori.
* #11300: Improve ``SigElementFallbackTransform`` fallback logic and signature
text elements nodes. See :doc:`the documentation </extdev/nodes>` for more
details.
Patch by Bénédikt Tran.
* Allow running Sphinx with ``python -m sphinx build ...``.
Bugs fixed
----------
* #11077: graphviz: Fix relative links from within the graph.
Patch by Ralf Grubenmann.
* #11529: Line Block in LaTeX builder outputs spurious empty token.
Patch by Adrian Vollmer.
* #11196: autosummary: Summary line extraction failed with "e.g."
* #10614: Fixed a number of bugs in inheritance diagrams that resulted in
missing or broken links.
Patch by Albert Shih.
* #9428: Exclude substitution definitions when running the ``gettext`` builder.
Patch by Alvin Wong.
* #10795: Raise a descriptive error if ``graphviz_dot`` is falsy.
* #11546: Translated nodes identical to their original text are now marked
with the ``translated=True`` attribute.
* #10049: html: Change "Permalink" to "Link" for title text \
in link anchors.
* #4225: Relax Pygments parsing on lexing failures.
* #11246: Allow inline links in the first line of a docstring and one-line
type comments ``#: :meta ...:`` when using :mod:`sphinx.ext.napoleon`.
Patch by Bénédikt Tran.
* #10930: Highlight all search terms on the search results page.
Patch by Dmitry Shachnev.
* #11473: Type annotations containing :py:data:`~typing.Literal` enumeration
values now render correctly.
Patch by Bénédikt Tran.
* #11591: Fix support for C coverage in ``sphinx.ext.coverage`` extension.
Patch by Stephen Finucane.
* #11594: HTML Theme: Enhancements to horizontal scrolling on smaller
devices in the ``agogo`` theme.
Patch by Lukas Engelter.
* #11459: Fix support for async and lambda functions in
``sphinx.ext.autodoc.preserve_defaults``.
Patch by Bénédikt Tran.
Testing
-------
* #11577: pytest: Fail tests on "XPASS".
* #11577: pytest: Use "importlib" import mode.
* #11577: pytest: Set PYTHONWARNINGS=error.
* #11577: pytest: Set strict config and strict markers.
|
2023-10-28 21:57:26 by Thomas Klausner | Files touched by this commit (516) | |
Log message:
python/wheel.mk: simplify a lot, and switch to 'installer' for installation
This follows the recommended bootstrap method (flit_core, build, installer).
However, installer installs different files than pip, so update PLISTs
for all packages using wheel.mk and bump their PKGREVISIONs.
|
2023-08-02 09:16:15 by Adam Ciarcinski | Files touched by this commit (3) | |
Log message:
py-sphinx: updated to 7.1.2
Release 7.1.2 (released Aug 02, 2023)
=====================================
Bugs fixed
----------
* linkcheck: Properly respect :confval:`linkcheck_anchors`
and do not spuriously report failures to validate anchors.
Patch by James Addison.
Release 7.1.1 (released Jul 27, 2023)
=====================================
Bugs fixed
----------
* Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer.
Patch by Bénédikt Tran.
Release 7.1.0 (released Jul 24, 2023)
=====================================
Incompatible changes
--------------------
* Releases are no longer signed, given the `change in PyPI policy`_.
.. _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/
Deprecated
----------
* Emit warnings on using a deprecated Python-specific index entry type
(namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``,
``statement``, and ``builtin``) in the :rst:dir:`index` directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.
Features added
--------------
* Add a checksum to JavaScript and CSS asset URIs included within
generated HTML, using the CRC32 algorithm.
* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version
requirement to be specified as ``(major, minor)``.
* Allow configuring a line-length limit for object signatures, via
:confval:`maximum_signature_line_length` and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:`py:function:single-line-parameter-list`.
Patch by Thomas Louf, Adam Turner, and Jean-François B.
* Support for multiline copyright statements in the footer block.
Patch by Stefanie Molin
* ``sphinx.util.display.status_iterator`` now clears the current line
with ANSI control codes, rather than overprinting with space characters.
* linkcheck: Treat SSL failures as broken links.
Patch by James Addison.
* Keep the ``translated`` attribute on translated nodes.
* Improve the traceback displayed when using :option:`sphinx-build -T`
in parallel builds. Patch by Bénédikt Tran
* linkcheck: Use session-basd HTTP requests.
* Add support for the :rst:dir:`py:class` and :rst:dir:`py:function`
directives for PEP 695 (generic classes and functions declarations) and
PEP 696 (default type parameters). Multi-line support is enabled
for type parameters list and can be locally controlled on object description
directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`.
Patch by Bénédikt Tran.
* linkcheck: Allow HTML anchors to be ignored on a per-URL basis
via :confval:`linkcheck_anchors_ignore_for_url` while
still checking the validity of the page itself.
Patch by Bénédikt Tran
* Add translation progress statistics and inspection support,
via a new substitution (``|translation progress|``) and a new
configuration variable (:confval:`translation_progress_classes`).
These enable determining the percentage of translated elements within
a document, and the remaining translated and untranslated elements.
Bugs fixed
----------
* Restored the ``footnote-reference`` class that has been removed in
the latest (unreleased) version of Docutils.
* Use :rfc:`8081` font file MIME types in the EPUB builder.
Using the correct MIME type will prevent warnings from ``epubcheck``
and will generate a valid EPUB.
* Use microsecond-resolution timestamps for outdated file detection
in ``BuildEnvironment.get_outdated_files``.
* Top-level headings starting with a reStructuredText role
now render properly when :confval:`rst_prolog` is set.
Previously, a file starting with the below would have
improperly rendered due to where the prologue text
was inserted into the document.
.. code:: rst
:mod:`lobster` -- The lobster module
====================================
...
Patch by Bénédikt Tran.
* Fix a ``MemoryError`` in ``sphinx.ext.intersphinx`` when using ``None``
or ``typing.*`` as inline type references. Patch by Bénédikt Tran (picnixz)
Testing
-------
* Always delete ``docutils.conf`` in test directories when running
``SphinxTestApp.cleanup()``.
|
2023-08-02 01:20:57 by Thomas Klausner | Files touched by this commit (158) |
Log message:
*: remove more references to Python 3.7
|
2023-05-15 23:01:45 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
py-sphinx: updated to 7.0.1
7.0.1
Dependencies
* Support `Docutils 0.20`_. Patch by Adam Turner.
Bugs fixed
* Clean up remaining references to ``sphinx.setup_command``
following the removal of support for setuptools.
Patch by Willem Mulder.
|
2023-05-04 11:42:10 by Adam Ciarcinski | Files touched by this commit (3) | |
Log message:
py-sphinx: updated to 7.0.0
Release 7.0.0 (released Apr 29, 2023)
Incompatible changes
* Remove long-deprecated aliases for MecabSplitter and DefaultSplitter in \
sphinx.search.ja.
* Remove deprecated make_old_id functions in domain object description classes.
* Remove the Setuptools integration (build_sphinx hook in setup.py).
* Remove deprecated sphinx.ext.napoleon.iterators module.
* Remove support for the jsdump format in sphinx.search.
* Make locale a required argument to sphinx.util.i18n.format_date().
* Remove deprecated sphinx.util.stemmer module.
* Remove deprecated sphinx.pycode.ast.parse() function.
* Remove deprecated sphinx.io.read_doc() function.
* Removed deprecated sphinx.util.get_matching_files() function.
* Remove deprecated sphinx.util.docutils.is_html5_writer_available() function.
* Make the env argument to Builder subclasses required.
* autosummary: Always emit grouped import exceptions.
* Remove deprecated style key for HTML templates.
* Remove deprecated sphinx.writers.latex.LaTeXTranslator.docclasses attribute.
* Remove deprecated sphinx.builders.html.html5_ready and \
sphinx.builders.html.HTMLTranslator attributes.
* Remove support for HTML 4 output.
|
2023-03-29 11:34:15 by Thomas Klausner | Files touched by this commit (96) |
Log message:
*: use PYTHON_VERSION instead of _PYTHON_VERSION
|
2022-10-25 20:36:42 by Adam Ciarcinski | Files touched by this commit (3) | |
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.
|
2022-04-15 17:58:35 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
py-sphinx: updated to 4.5.0
Release 4.5.0 (released Mar 28, 2022)
=====================================
Incompatible changes
--------------------
* extlinks: Disable hardcoded links detector by default
* std domain: Disallow to refer an inline target via
:rst:role:`ref` role
Deprecated
----------
* ``sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()``
Features added
--------------
* Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring
* autosummary: Add "autosummary" CSS class to summary tables
* extlinks: Improve suggestion message for a reference having title
* extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable
hardcoded links detector feature
* html search: Add a config variable
:confval:`html_show_search_summary` to enable/disable the search summaries
* HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:'/' as
a Quick search shortcut and :kbd:`Esc` shortcut that
removes search highlighting.
* i18n: Allow to suppress translation warnings by adding ``#noqa``
comment to the tail of each translation message
* C++, support attributes on classes, unions, and enums.
* :rst:dir:`pep` role now generates URLs based on peps.python.org
Bugs fixed
----------
* autodoc: Failed to document an imported class that is built from native
binary module
* autodoc: Crashed when mocked module is used for type annotation
* autodoc: :confval:`autodoc_default_options` does not support
``no-value`` option
* autodoc: TypeError is raised when the target object is annotated by
unhashable object
* extlinks: Failed to compile regexp on checking hardcoded links
* html search: Could not search short words (ex. "use")
* LaTeX: named auto numbered footnote (ex. ``[#named]``) that is referred
multiple times was rendered to a question mark
* LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical
spacing in Latexpdf
* LaTeX: excessive whitespace since v4.4.0 for undocumented
variables/structure members
* LaTeX: named footnote reference is linked to an incorrect footnote if
the name is also used in the different document
* manpage: Failed to resolve the title of :ref: cross references
* i18n: suppress "rST localization" warning
* imgconverter: Unnecessary availablity check is called for remote URIs
* napoleon: attributes are displayed like class attributes for google
style docstrings when :confval:`napoleon_use_ivar` is enabled
* sphinx-build: make.bat does not check the installation of sphinx-build
command before showing help
|