| CARVIEW |
Select Language
HTTP/2 200
expires: Thu, 19 Nov 1981 08:52:00 GMT
cache-control: no-store, no-cache, must-revalidate
pragma: no-cache
set-cookie: PHPSESSID=grud64smjsrtojbpq8ss113sk4; path=/
content-type: text/html; charset=UTF-8
date: Sat, 27 Dec 2025 16:17:02 GMT
server: Apache
pkgsrc.se | The NetBSD package collection
archivers
audio
benchmarks
biology
cad
chat
comms
converters
cross
crosspkgtools
databases
devel
doc
editors
emulators
filesystems
finance
fonts
games
geography
graphics
ham
inputmethod
lang
mail
math
mbone
meta-pkgs
misc
multimedia
net
news
parallel
pkgtools
print
regress
security
shells
sysutils
textproc
py-sphin..
time
wip
wm
www
x11
* = Virtual Category
Path to this page:
./textproc/py-sphinx, Python documentation generator
[
Branch: CURRENT, Version: 9.0.4, Package name: py313-sphinx-9.0.4, Maintainer: markd
Sphinx 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]
Navigation:
-
Browse pkgsrc
(this page)
archivers
audio
benchmarks
biology
cad
chat
comms
converters
cross
crosspkgtools
databases
devel
doc
editors
emulators
filesystems
finance
fonts
games
geography
graphics
ham
inputmethod
lang
math
mbone
meta-pkgs
misc
multimedia
net
news
parallel
pkgtools
regress
security
shells
sysutils
textproc
py-sphin..time
wip
wm
www
x11
* = Virtual Category
Path to this page:
./textproc/py-sphinx, Python documentation generator
[
CVSweb ] [
Homepage ] [
RSS ] [
Required by ] [
Add to tracker ]
Branch: CURRENT, Version: 9.0.4, Package name: py313-sphinx-9.0.4, Maintainer: markd
Sphinx 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: 8506.35 KBVersion history: (Expand)
- (2025-12-21) Updated to version: py313-sphinx-9.0.4
- (2025-10-09) Updated to version: py313-sphinx-8.2.3
- (2025-03-03) Updated to version: py312-sphinx-8.2.3
- (2025-02-23) Updated to version: py312-sphinx-8.2.1
- (2024-10-19) Updated to version: py312-sphinx-8.1.3
- (2024-10-19) Updated to version: py312-sphinx-8.1.2
CVS history: (Expand)
| 2025-12-21 18:39:12 by Thomas Klausner | Files touched by this commit (3) | |
Log message:
py-sphinx: update to 9.0.4.
Release 9.0.4 (released Dec 04, 2025)
Bugs fixed
#14143: Fix spurious build warnings when translators reorder references in \
strings, or use translated display text in references. Patch by Matt Wang.
Release 9.0.3 (released Dec 04, 2025)
Bugs fixed
#14142: autodoc: Restore some missing exports in sphinx.ext.autodoc. Patch \
by Adam Turner.
Release 9.0.2 (released Dec 03, 2025)
Bugs fixed
#14142: autodoc: Restore sphinx.ext.autodoc.mock. Patch by Adam Turner.
Release 9.0.1 (released Dec 01, 2025)
Bugs fixed
#13942: autodoc: Restore the mapping interface for options objects. Patch by \
Adam Turner.
#13942: autodoc: Deprecate the mapping interface for options objects. Patch \
by Adam Turner.
#13387: Update translations.
Release 9.0.0 (released Nov 30, 2025)
Dependencies
#13786: Support Docutils 0.22. Patch by Adam Turner.
Incompatible changes
#13639: SphinxComponentRegistry.create_source_parser() no longer has an app \
parameter, instead taking config and env. Patch by Adam Turner.
#13679: Non-decodable characters in source files now raise an error. Such \
bytes have been replaced with ‘?’ along with logging a warning since Sphinx \
2.0. Patch by Adam Turner.
#13751, #14089: sphinx.ext.autodoc has been substantially rewritten, and \
there may be some incompatible changes in edge cases, especially when extensions \
interact with autodoc internals. The autodoc_use_legacy_class_based option has \
been added to use the legacy (pre-9.0) implementation of autodoc. Patches by \
Adam Turner.
#13355: Don’t include escaped title content in the search index. Patch by \
Will Lachance.
Deprecated
13627: Deprecate remaining public .app attributes, including builder.app, \
env.app, events.app, and SphinxTransform.app. Patch by Adam Turner.
#13637: Deprecate the set_application() method of Parser objects. Patch by \
Adam Turner.
#13644: Deprecate the Parser.config and env attributes. Patch by Adam Turner.
#13665: Deprecate support for non-UTF 8 source encodings, scheduled for \
removal in Sphinx 10. Patch by Adam Turner.
#13682: Deprecate sphinx.io. Sphinx no longer uses the sphinx.io classes, \
having replaced them with standard Python I/O. The entire sphinx.io module will \
be removed in Sphinx 10. Patch by Adam Turner.
#13631: sphinx.environment.adapters.toctree.global_toctree_for_doc() and \
sphinx.environment.BuildEnvironment.get_and_resolve_doctree() will require a \
tags keyword argument from Sphinx 11. It may optionally be passed from Sphinx 9 \
onwards. Patch by Adam Turner.
Features added
#13332: Add doctest_fail_fast option to exit after the first failed test. \
Patch by Till Hoffmann.
#13439: linkcheck: Permit warning on every redirect with \
linkcheck_allowed_redirects = {}. Patch by Adam Turner and James Addison.
#13497: Support C domain objects in the table of contents.
#13500: LaTeX: add support for fontawesome6 package. Patch by Jean-François B.
#13509: autodoc: Detect typing_extensions.overload and final() decorators. \
Patch by Spencer Brown.
#13535: html search: Update to the latest version of Snowball (v3.0.1). \
Patch by Adam Turner.
#13647: LaTeX: allow more cases of table nesting. Patch by Jean-François B.
#13657: LaTeX: support CSS3 length units. Patch by Jean-François B.
#13684: intersphinx: Add a file-based cache for remote inventories. The \
location of the cache directory must not be relied upon externally, as it may \
change without notice or warning in future releases. Patch by Adam Turner.
#13805: LaTeX: add support for fontawesome7 package. Patch by Jean-François B.
#13508: autodoc: Initial support for PEP 695 type aliases. Patch by Martin \
Matouš, Jeremy Maitin-Shepard, and Adam Turner.
#14023: Add the new mathjax_config_path option to load MathJax configuration \
from a file. Patch by Randolf Scholz and Adam Turner.
#14046: linkcheck: Add the linkcheck_case_insensitive_urls option to allow \
case-insensitive URL comparison for specific URL patterns. This is useful for \
links to websites that normalise URL casing (e.g. GitHub) or case-insensitive \
servers. Patch by Fazeel Usmani and James Addison.
#14075: autosummary: Provide more context in import exception stack traces. \
Patch by Philipp A.
#13468: Add config options to sphinx.ext.duration. Patch by Erik Bedard and \
Adam Turner.
#14022: Use MathJax v4 by default in the sphinx.ext.mathjax extension, from \
v3 previously. To keep using an older version, set the mathjax_path option. Also \
add the new mathjax4_config option to configure MathJax v4. Note that MathJax v3 \
is mostly compatible with MathJax v4, so existing mathjax3_config settings \
should not need to change. Patch by Matthias Geier.
#14029: intersphinx: Fix error in format string interpolation. Patch by \
Matthieu de Cibeins.
#13894: Add source_code_parser type to suppress_warnings for grouping issues \
related to the C and C++ parsers. Patch by Valentin H.
Bugs fixed
#13926: multiple py:type directives for the same canonical type no longer \
result in spurious duplicate object description warnings. Patch by Jeremy \
Maitin-Shepard.
#1327: LaTeX: tables using longtable raise error if tabularcolumns specifies \
automatic widths (L, R, C, or J). Patch by Jean-François B.
#3447: LaTeX: when assigning longtable class to table for PDF, it may render \
“horizontally” and overflow in right margin. Patch by Jean-François B.
#8828: LaTeX: adding a footnote to a longtable cell causes table to occupy \
full width. Patch by Jean-François B.
#11498: LaTeX: Table in cell fails to build if it has many rows. Patch by \
Jean-François B.
#11515: LaTeX: longtable does not allow nested table. Patch by Jean-François B.
#11973: LaTeX: links in table captions do not work in PDF. Patch by \
Jean-François B.
#12821: LaTeX: URLs/links in section titles should render in PDF. Patch by \
Jean-François B.
#13369: Correctly parse and cross-reference unpacked type annotations. Patch \
by Alicia Garcia-Raboso.
#13528: Add tilde ~ prefix support for py:deco. Patch by Shengyu Zhang and \
Adam Turner.
#13597: LaTeX: table nested in a merged cell leads to invalid LaTeX mark-up \
and PDF cannot be built. Patch by Jean-François B.
#13619: LaTeX: possible duplicated footnotes in PDF from object signatures \
(typically if latex_show_urls = 'footnote'). Patch by Jean-François B.
#13635: LaTeX: if a cell contains a table, row coloring is turned off for \
the next table cells. Patch by Jean-François B.
#13685: gettext: Correctly ignore trailing backslashes. Patch by Bénédikt Tran.
#13712: intersphinx: Don’t add “v” prefix to non-numeric versions. \
Patch by Szymon Karpinski.
#13688: HTML builder: Replace <em class="property"> with \
<span class="property"> for attribute type annotations to \
improve semantic HTML structure. Patch by Mark Ostroth.
#13812 (discussion): LaTeX: long confval value does not wrap at spaces in \
PDF. Patch by Jean-François B.
#10785: Autodoc: Allow type aliases defined in the project to be properly \
cross-referenced when used as type annotations. This makes it possible for \
objects documented as :py:data: to be hyperlinked in function signatures.
#13858: doctest: doctest blocks are now correctly added to a group defined \
by the configuration variable doctest_test_doctest_blocks.
#13885: Coverage builder: Fix TypeError when warning about missing modules. \
Patch by Damien Ayers.
#13929: Duplicate equation label warnings now have a new warning sub-type, \
ref.equation. Patch by Jared Dillard.
#13935: autoclass: parent class members no longer considered directly \
defined in certain cases, depending on autodoc processing order. Patch by Jeremy \
Maitin-Shepard.
#13939: LaTeX: page break can separate admonition title from contents. Patch \
by Jean-François B.
#14004: Fix autodoc_type_aliases when they appear in PEP 604 union syntax \
(Alias | Type). Patch by Tamika Nomara.
#14059: LaTeX: Footnotes cause pdflatex error with French language (since \
late June 2025 upstream change to LaTeX babel-french). Patch by Jean-François \
B.
#13916: HTML Search: do not clear text fragments from the URL on page load. \
Patch by Harmen Stoppels.
#13944: autodoc: show traceback during import in human readable \
representation. Patch by Florian Best.
#14006: Support images with data URIs that aren’t base64-encoded. Patch by \
Shengyu Zhang and Adam Turner.
#12797: Fix Some type variables (...) are not listed in Generic[...] \
TypeError when inheriting from both Generic and autodoc mocked class. Patch by \
Ikor Jefocur and Daniel Sperber.
#13945: autodoc: Fix handling of undefined names in annotations by using the \
FORWARDREF annotationlib format. Patch by Rui Pinheiro and Adam Turner.
#14067: EPUB: unify path separators in manifest items to forward slashes; \
resolve duplicates in the manifest on Windows. Patch by Akihiro Takizawa.
#13741: text builder: fix an infinite loop when processing CSV tables. Patch \
by Bénédikt Tran.
#13217: Remove extra parentheses from js:function arguments and errors. \
Patch by Shengyu Zhang.
|
| 2025-12-21 18:22:57 by Thomas Klausner | Files touched by this commit (1) |
Log message: py-sphinx: switch to py-roman_numerals Bump PKGREVISION. |
| 2025-10-09 09:58:14 by Thomas Klausner | Files touched by this commit (442) |
Log message: *: remove reference to (removed) Python 3.9 |
| 2025-03-03 10:41:38 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message:
py-sphinx: updated to 8.2.3
Release 8.2.3 (released Mar 02, 2025)
Bugs fixed
* Define ``_StrPath.__radd__()``.
* Fix _CurrentDocument membership testing with '{c,cpp}:parent_symbol'.
Release 8.2.2 (released Mar 02, 2025)
Bugs fixed
* Fix argument type for ``jieba.load_userdict()``.
* Add workaround for ``nbsphinx`` implicit imports.
* Ensure inline ``<script/>`` tags are written exactly once.
* apidoc: Fix TOC file not having a title.
|
| 2025-02-23 17:59:26 by Thomas Klausner | Files touched by this commit (79) |
Log message: *: py-sphinx 8.2 drops support for Python 3.10 |
| 2025-02-23 17:41:56 by Thomas Klausner | Files touched by this commit (3) | |
Log message: py-sphinx: update to 8.2.1. Release 8.2.1 (released Feb 21, 2025) ===================================== Bugs fixed ---------- * #13367: Correct spelling of ``highlighting_failure`` in warning sub-type. Patch by Bart Kamphorst. * #13377: Restore support for using ``sphinx.testing.path`` paths with ``sphinx.testing.fixtures``. Patch by Kazuya Takei. * #13380: viewcode: Fix importing modules more than once. Patch by Dave Hoese. * #13382: Napoleon: Use the right valid types for configuration values. Patch by Adam Turner. * 13376: Fix copying assets from a relative :confval:`html_static_path` entry. Patch by Adam Turner. Release 8.2.0 (released Feb 18, 2025) ===================================== Dependencies ------------ * #13000: Drop Python 3.10 support. Incompatible changes -------------------- * #13044: Remove the internal and undocumented ``has_equations`` data from the :py:class:`!MathDomain` domain. The undocumented :py:meth:`!MathDomain.has_equations` method now unconditionally returns ``True``. These are replaced by the ``has_maths_elements`` key of the page context dict. Patch by Adam Turner. * #13227: HTML output for sequences of keys in the :rst:role:`kbd` role no longer uses a ``<kbd class="kbd compound">`` element to wrap the keys and separators, but places them directly in the relevant parent node. This means that CSS rulesets targeting ``kbd.compound`` or ``.kbd.compound`` will no longer have any effect. Patch by Adam Turner. Deprecated ---------- * #13037: Deprecate the ``SingleHTMLBuilder.fix_refuris`` method. Patch by James Addison. * #13083, #13330: Un-deprecate ``sphinx.util.import_object``. Patch by Matthias Geier. Features added -------------- * #13173: Add a new ``duplicate_declaration`` warning type, with ``duplicate_declaration.c`` and ``duplicate_declaration.cpp`` subtypes. Patch by Julien Lecomte and Adam Turner. * #11824: linkcode: Allow extensions to add support for a domain by defining the keys that should be present. Patch by Nicolas Peugnet. * #13144: Add a ``class`` option to the :rst:dir:`autosummary` directive. Patch by Tim Hoffmann. * #13146: Napoleon: Unify the type preprocessing logic to allow Google-style docstrings to use the optional and default keywords. Patch by Chris Barrick. * #13227: Implement the :rst:role:`kbd` role as a ``SphinxRole``. Patch by Adam Turner. * #13065: Enable colour by default in when running on CI. Patch by Adam Turner. * #13230: Allow supressing warnings from the :rst:dir:`toctree` directive when a glob pattern doesn't match any documents, via the new ``toc.empty_glob`` warning sub-type. Patch by Slawek Figiel. * #9732: Add the new ``autodoc.mocked_object`` warnings sub-type. Patch by Cyril Roelandt. * #7630, #4824: autodoc: Use :file:`.pyi` type stub files to auto-document native modules. Patch by Adam Turner, partially based on work by Allie Fitter. * #12975: Enable configuration of trailing commas in multi-line signatures in the Python and Javascript domains, via the new :confval:`python_trailing_comma_in_multi_line_signatures` and :confval:`javascript_trailing_comma_in_multi_line_signatures` configuration options. * #13264: Rename the :rst:dir:`math` directive's ``nowrap`` option to :rst:dir:`math:no-wrap`. Patch by Adam Turner. * #13269: Added the option to disable the use of type comments in via the new :confval:`autodoc_use_type_comments` option, which defaults to ``True`` for backwards compatibility. The default will change to ``False`` in Sphinx 10. Patch by Adam Turner. * #9732: Add the new ``ref.any`` warnings sub-type to allow suppressing the ambiguous 'any' cross-reference warning. Patch by Simão Afonso and Adam Turner. * #13272: The Python and JavaScript module directives now support the ``:no-index-entry:`` option. Patch by Adam Turner. * #12233: autodoc: Allow directives to use ``:no-index-entry:`` and include the ``:no-index:`` and ``:no-index-entry:`` options within :confval:`autodoc_default_options`. Patch by Jonny Saunders and Adam Turner. * #13172: Add support for short signatures in autosummary. Patch by Tim Hoffmann. * #13271: Change the signature prefix for abstract methods in the Python domain to *abstractmethod* from *abstract*. Patch by Adam Turner. * #13271: Support the ``:abstract:`` option for classes, methods, and properties in the Python domain. Patch by Adam Turner. * #12507: Add the :ref:`collapsible <collapsible-admonitions>` option to admonition directives. Patch by Chris Sewell. * #8191, #8159: Add :rst:dir:`inheritance-diagram:include-subclasses` option to the :rst:dir:`inheritance-diagram` directive. Patch by Walter Dörwald. * #11995: autodoc: Add support for :confval:`python_display_short_literal_types`. Patch by Bénédikt Tran and Adam Turner. * #13163: Always print the full context when Sphinx encounters an internal error. Patch by Kevin Deldycke and Adam Turner. * #13105: Introduce the :rst:role:`py:deco` role to cross-reference decorator functions and methods in the Python domain. Patch by Adam Turner. * #9169: Add the :confval:`intersphinx_resolve_self` option to resolve an intersphinx reference to the current project. Patch by Jakob Lykke Andersen and Adam Turner. * #11280: Add ability to skip a particular section using the ``no-search`` class. Patch by Will Lachance. * #13326: Remove hardcoding from handling :class:`~sphinx.addnodes.productionlist` nodes in all writers, to improve flexibility. Patch by Adam Turner. * #13335: Use ``misc.highlighting_failure`` subtype for Pygments unknown lexers. Patch by Bart Kamphorst. * #13354: Insert abbreviation nodes (hover text) for positional- and keyword-only separators in Python signatures. Patch by Adam Turner. * #13333: Add the :mod:`sphinx.ext.apidoc` extension, to automate API documentation generation from Python modules. Patch by Chris Sewell and Adam Turner. Bugs fixed ---------- * #12463: autosummary: Respect an empty module ``__all__``. Patch by Valentin Pratz * #13060: HTML Search: use ``Map`` to store per-file term scores. Patch by James Addison * #13130: LaTeX docs: ``pdflatex`` index creation may fail for index entries in French. See :confval:`latex_use_xindy`. Patch by Jean-François B. * #13152: LaTeX: fix a typo from v7.4.0 in a default for ``\sphinxboxsetup``. Patch by Jean-François B. * #13096: HTML Search: check that query terms exist as properties in term indices before accessing them. * #11233: linkcheck: match redirect URIs against :confval:`linkcheck_ignore` by overriding session-level ``requests.get_redirect_target``. * #13195: viewcode: Fix issue where import paths differ from the directory structure. Patch by Ben Egan and Adam Turner. * #13188: autodoc: fix detection of class methods implemented in C. Patch by Bénédikt Tran. * #1810: Always copy static files when building, regardless of whether any documents have changed since the previous build. Patch by Adam Turner. * #13201: autodoc: fix ordering of members when using ``groupwise`` for :confval:`autodoc_member_order`. Class methods are now rendered before static methods, which themselves are rendered before regular methods and attributes. Patch by Bénédikt Tran. * #12975: Avoid rendering a trailing comma in C and C++ multi-line signatures. * #13178: autodoc: Fix resolution for ``pathlib`` types. Patch by Adam Turner. * #13136: autodoc: Correctly handle multiple inheritance. Patch by Pavel Holica * #13273, #13318: Properly convert command-line overrides for Boolean types. Patch by Adam Turner. * #13302, #13319: Use the correct indentation for continuation lines in :rst:dir:`productionlist` directives. Patch by Adam Turner. * #13328: Fix parsing of PEP 695 functions with return annotations. Patch by Bénédikt Tran. Initial work by Arash Badie-Modiri. Testing ------- * #13224: Correctness fixup for ``test_html_multi_line_copyright``. Patch by Colin Watson, applied by James Addison. |
| 2024-12-06 11:47:03 by Adam Ciarcinski | Files touched by this commit (1) |
Log message: py-sphinx: not for Python 3.9 |
| 2024-10-19 18:12:30 by Adam Ciarcinski | Files touched by this commit (2) | |
Log message: py-sphinx: updated to 8.1.3 Release 8.1.3 (released Oct 13, 2024) Bugs fixed * Restore support for :func:`!cut_lines` with no object type. |
