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

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

Branch: CURRENT, Version: 1.8.0, Package name: py312-numpydoc-1.8.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: 88.325 KB

Version history: (Expand)

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+
   2022-07-10 20:58:06 by Thomas Klausner | Files touched by this commit (1) 
Log message:
py-numpydoc: restrict to python 3
   2022-04-19 14:05:35 by Tobias Nygren | Files touched by this commit (1) 
Log message:
py-numpydoc: use versioned dependencies for jinja2
   2022-01-04 21:55:40 by Thomas Klausner | Files touched by this commit (1595) 
Log message:
*: bump PKGREVISION for egg.mk users

They now have a tool dependency on py-setuptools instead of a DEPENDS
   2021-10-26 13:23:42 by Nia Alarie | Files touched by this commit (1161) 
Log message:
textproc: Replace RMD160 checksums with BLAKE2s checksums

All checksums have been double-checked against existing RMD160 and
SHA512 hashes

Unfetchable distfiles (fetched conditionally?):
./textproc/convertlit/distinfo clit18src.zip
   2021-10-07 17:02:49 by Nia Alarie | Files touched by this commit (1162) 
Log message:
textproc: Remove SHA1 hashes for distfiles
   2019-10-22 00:01:06 by Adam Ciarcinski | Files touched by this commit (5) 
Log message:
Switch sphinx to versioned deps.
   2019-06-14 17:17:18 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-numpydoc: updated to 0.9.1

numpydoc 0.9.1
Updating minimum sphinx version in setup.py

numpydoc 0.9.0
Implemented enhancements:
MAINT: Add CircleCI
ENH: accept autoclass member options
Clarify location of certain invalid docstrings.
ENH: Xref param type
Make parameter a namedtuple
ENH: Added support for multiple functions+description in a See Also block
DOC: Added example of multi-line code in Examples section.
switch the test suite to pytest
Report object name upon mangle_docstrings exception
Add option to use member listing for attributes
Require that sphinx issue no warnings in CI
Command-line tool to help debug NumpyDocString
Support Receives section for generator.send(...) params

Fixed bugs:
References messed up
BUG?: References always have an errant second link
BUG: turn member descriptor attributes into links
FIX: Fix collections.abc imports
FIX: Escape chars in re
Fix markup in format.rst.
Move setup of autosummary earlier in setup().
Only print the index if it is necessary.
FIX pedantic handling of whitespace in reference regex
FIX remove duplicated citation back-references
Use DEDUPLICATION_TAG to determine whether a citation node is in a docstring
FIX parsing of type-only return params
pip --use-wheel no longer exists
DOC: Add missing backslash to omega for inline math example.
DOC: remove links to numpy repo file
Escape the * in *args and **kwargs

Closed issues:
autosummary fails with numpydoc where napoleon succeeds
NumpyDocString doesn't roundtrip well
Generating a docstring from a numpydoc object
make parameters and attributes anchors in docstrings
BUG: Plot(s) not rendered if docstring ends with normal text after show command
Location reporting returns useless information
Anonymous return values have their types populated in the name slot of the tuple.
support for coroutine
multiple entries in a See Also section