./textproc/py-numpydoc, Sphinx extension to support docstrings in Numpy format

[ Image CVSweb ] [ Image Homepage ] [ Image RSS ] [ Image Required by ] [ Image Add to tracker ]

Branch: CURRENT, Version: 1.10.0, Package name: py313-numpydoc-1.10.0, Maintainer: jihbed.research

Numpy's documentation uses several custom extensions to Sphinx.

The following extensions are available:

* numpydoc: support for the Numpy docstring format in Sphinx, and
add the code description directives np:function, np-c:function,
etc. that support the Numpy docstring syntax.
* numpydoc.traitsdoc: For gathering documentation about Traits
attributes.
* numpydoc.plot_directive: Adaptation of Matplotlib's plot::
directive. Note that this implementation may still undergo severe
changes or eventually be deprecated.


Required to run:
[textproc/py-sphinx] [textproc/py-jinja2] [lang/python310]

Master sites:

Filesize: 91.823 KB

Version history: (Expand)

CVS history: (Expand)


   2026-01-06 12:18:20 by Thomas Klausner | Files touched by this commit (51) 
Log message:
*: forbid Python 3.11 for sphinx users

list from 'bob scan'
   2025-12-15 13:02:34 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-numpydoc: updated to 1.10.0

1.10.0

Enhancements

Added "exclude_files" option for pyproject.toml config usage.
Constructor checking for AST validator

Requirements

build(pyproject.toml): drop support for python 3.9 (require 3.10+)

Bugfixes

FIX: account for unreleased changes to sphinx
Remove duplicate dependency in pyproject.toml
TST: A few minor test improvements
Fix test warnings about invalid regex escape
MAINT: rm unused kwarg from private method.
Fix pytest warning regression by switching to re.escape()
   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-07-25 13:32:36 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-numpydoc: updated to 1.9.0

1.9.0

Enhancements

ignore some errors at module level
Rework hook output to remove the table
Switch to storing AST nodes on the stack for more accurate method signature \ 
check and easy access to parent nodes

Bug Fixes

MAINT: Changed class constructor init GL08 reporting
BUG: Correct functionality of numpydoc SS05
Specity the types of numpydoc_xref_ignore option

Documentation

DOC: Do not use types for *args, **kwargs
mention conda-forge in installation docs
Fix typo in validation.rst
Fix broken link in format.rst

Maintenance

CI: use hashes for actions' versions in publishing job
Bump the actions group with 2 updates
Bump pypa/gh-action-pypi-publish from 1.10.0 to 1.10.2 in the actions group
[pre-commit.ci] pre-commit autoupdate
MAINT: Add _exception_on_warning to MockApp
Bump the actions group across 1 directory with 2 updates
don't pass maxsplit as positional arg
[pre-commit.ci] pre-commit autoupdate
Add Python 3.13 support
Update readthedocs config
Bump the actions group with 2 updates
Bump the actions group with 3 updates
[pre-commit.ci] pre-commit autoupdate
Bump actions/download-artifact from 4.2.1 to 4.3.0 in the actions group
Bump scientific-python/circleci-artifacts-redirector-action from 1.0.0 to 1.1.0 \ 
in the actions group
Switch to dependency groups
Fix pip setup command in github workflow
   2025-04-14 14:39:22 by Adam Ciarcinski | Files touched by this commit (32) | Package updated
Log message:
Fix PLIST after py-setuptools update; bump depends and revision
   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
   2024-11-11 08:29:31 by Thomas Klausner | Files touched by this commit (862) 
Log message:
py-*: remove unused tool dependency

py-setuptools includes the py-wheel functionality nowadays
   2024-10-14 08:46:10 by Thomas Klausner | Files touched by this commit (325) 
Log message:
*: clean-up after python38 removal