Path to this page:
./
textproc/py-sphinx,
Python documentation generator
Branch: CURRENT,
Version: 7.2.6,
Package name: py311-sphinx-7.2.6,
Maintainer: markdSphinx is a tool that makes it easy to create intelligent and beautiful
documentation for Python projects (or other documents consisting of multiple
reStructuredText sources), written by Georg Brandl. It was originally
created to translate the new Python documentation, but has now been cleaned
up in the hope that it will be useful to many other projects.
Sphinx uses reStructuredText as its markup language, and many of its
strengths come from the power and straightforwardness of reStructuredText
and its parsing and translating suite, the Docutils.
Although it is still under constant development, the following features are
already present, work fine and can be seen "in action" in the Python docs:
* Output formats: HTML (including Windows HTML Help), plain text and LaTeX,
for printable PDF versions
* Extensive cross-references: semantic markup and automatic links for
functions, classes, glossary terms and similar pieces of information
* Hierarchical structure: easy definition of a document tree, with automatic
links to siblings, parents and children
* Automatic indices: general index as well as a module index
* Code handling: automatic highlighting using the Pygments highlighter
* Various extensions are available, e.g. for automatic testing of snippets
and inclusion of appropriately formatted docstrings.
Required to run:[
textproc/py-docutils] [
time/py-pytz] [
devel/py-babel] [
textproc/py-pygments] [
textproc/py-jinja2] [
devel/py-requests] [
textproc/py-snowballstemmer] [
textproc/py-alabaster] [
graphics/py-imagesize] [
devel/py-packaging] [
textproc/py-sphinxcontrib-devhelp] [
textproc/py-sphinxcontrib-applehelp] [
textproc/py-sphinxcontrib-jsmath] [
textproc/py-sphinxcontrib-serializinghtml] [
textproc/py-sphinxcontrib-qthelp] [
textproc/py-sphinxcontrib-htmlhelp] [
lang/python310]
Required to build:[
devel/py-flit_core]
Master sites:
Filesize: 6850.765 KB
Version history: (Expand)
- (2023-11-08) Updated to version: py311-sphinx-7.2.6
- (2023-10-28) Updated to version: py311-sphinx-7.1.2nb1
- (2023-08-02) Updated to version: py310-sphinx-7.1.2
- (2023-05-15) Updated to version: py310-sphinx-7.0.1
- (2023-05-04) Updated to version: py310-sphinx-7.0.0
- (2022-10-25) Updated to version: py310-sphinx-5.3.0
CVS history: (Expand)
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
|