Debian Codegraph @

PKG-INFO

raw
1 Metadata-Version: 2.4
2 Name: numpydoc
3 Version: 1.9.0
4 Summary: Sphinx extension to support docstrings in Numpy format
5 Author-email: Pauli Virtanen and others <[email protected]>
6 License: Copyright (C) 2008-2023 Stefan van der Walt <[email protected]>, Pauli Virtanen <[email protected]>
7
8 Redistribution and use in source and binary forms, with or without
9 modification, are permitted provided that the following conditions are
10 met:
11
12 1. Redistributions of source code must retain the above copyright
13 notice, this list of conditions and the following disclaimer.
14 2. Redistributions in binary form must reproduce the above copyright
15 notice, this list of conditions and the following disclaimer in
16 the documentation and/or other materials provided with the
17 distribution.
18
19 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
23 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
28 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 POSSIBILITY OF SUCH DAMAGE.
30
31 Project-URL: Homepage, https://numpydoc.readthedocs.io
32 Project-URL: Source, https://github.com/numpy/numpydoc/
33 Keywords: sphinx,numpy
34 Classifier: Development Status :: 5 - Production/Stable
35 Classifier: Environment :: Plugins
36 Classifier: Intended Audience :: Developers
37 Classifier: License :: OSI Approved :: BSD License
38 Classifier: Operating System :: OS Independent
39 Classifier: Programming Language :: Python
40 Classifier: Programming Language :: Python :: 3
41 Classifier: Programming Language :: Python :: 3.9
42 Classifier: Programming Language :: Python :: 3.10
43 Classifier: Programming Language :: Python :: 3.11
44 Classifier: Programming Language :: Python :: 3.12
45 Classifier: Programming Language :: Python :: 3.13
46 Classifier: Topic :: Documentation
47 Requires-Python: >=3.9
48 Description-Content-Type: text/x-rst
49 License-File: LICENSE.txt
50 Requires-Dist: sphinx>=6
51 Requires-Dist: tomli>=1.1.0; python_version < "3.11"
52 Dynamic: license-file
53
54 =====================================
55 numpydoc -- Numpy's Sphinx extensions
56 =====================================
57
58 .. image:: https://readthedocs.org/projects/numpydoc/badge/?version=latest
59 :alt: Documentation Status
60 :target: https://numpydoc.readthedocs.io/en/latest/
61
62 .. image:: https://codecov.io/gh/numpy/numpydoc/branch/main/graph/badge.svg
63 :target: https://app.codecov.io/gh/numpy/numpydoc/branch/main
64
65 .. image:: https://github.com/numpy/numpydoc/actions/workflows/test.yml/badge.svg?branch=main
66 :target: https://github.com/numpy/numpydoc/actions/workflows/test.yml
67
68 This package provides the ``numpydoc`` Sphinx extension for handling
69 docstrings formatted according to the NumPy documentation format.
70 The extension also adds the code description directives
71 ``np:function``, ``np-c:function``, etc.
72
73 numpydoc requires Python 3.9+ and sphinx 6+.
74
75 For usage information, please refer to the `documentation
76 <https://numpydoc.readthedocs.io/>`_.
77
78 The `numpydoc docstring guide
79 <https://numpydoc.readthedocs.io/en/latest/format.html>`_ explains how
80 to write docs formatted for this extension, and the `user guide
81 <https://numpydoc.readthedocs.io>`_ explains how to use it with Sphinx.