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

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


Branch: CURRENT, Version: 0.9.1, Package name: py37-numpydoc-0.9.1, 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:
[devel/py-setuptools] [textproc/py-sphinx] [textproc/py-jinja2] [lang/python37]

Required to build:
[pkgtools/cwrappers]

Master sites:

SHA1: 2d91540ef54dba7f9f45324fb31b693271f8157e
RMD160: 14a0bddfb0cf0d9810b92055d7b3c680830132e3
Filesize: 26.937 KB

Version history: (Expand)


CVS history: (Expand)


   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
   2018-08-29 13:04:42 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-numpydoc: updated to 0.8.0

0.8.0:
Unknown changes.
   2017-12-14 14:36:12 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-numpydoc: updated to 0.7.0

Changes unknown.
   2016-06-08 19:43:49 by Thomas Klausner | Files touched by this commit (356)
Log message:
Switch to MASTER_SITES_PYPI.
   2015-12-11 20:23:57 by Joerg Sonnenberger | Files touched by this commit (1)
Log message:
Don't install unreadable files. Bump revision.
   2015-11-04 03:00:17 by Alistair G. Crooks | Files touched by this commit (797)
Log message:
Add SHA512 digests for distfiles for textproc category

Problems found locating distfiles:
	Package cabocha: missing distfile cabocha-0.68.tar.bz2
	Package convertlit: missing distfile clit18src.zip
	Package php-enchant: missing distfile php-enchant/enchant-1.1.0.tgz

Otherwise, existing SHA1 digests verified and found to be the same on
the machine holding the existing distfiles (morden).  All existing
SHA1 digests retained for now as an audit trail.
   2014-08-09 23:53:31 by Thomas Klausner | Files touched by this commit (4)
Log message:
Import py34-numpydoc-0.5 as textproc/py-numpydoc; packaged for wip
by jihbed.

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.