| Name | numpydoc JSON |
| Version |
1.6.0
JSON |
| download |
| home_page | |
| Summary | Sphinx extension to support docstrings in Numpy format |
| upload_time | 2023-09-26 00:24:33 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Copyright (C) 2008-2023 Stefan van der Walt <stefan@mentat.za.net>, Pauli Virtanen <pav@iki.fi> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
sphinx
numpy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
=====================================
numpydoc -- Numpy's Sphinx extensions
=====================================
.. image:: https://readthedocs.org/projects/numpydoc/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://numpydoc.readthedocs.io/en/latest/
.. image:: https://codecov.io/gh/numpy/numpydoc/branch/main/graph/badge.svg
:target: https://app.codecov.io/gh/numpy/numpydoc/branch/main
.. image:: https://github.com/numpy/numpydoc/actions/workflows/test.yml/badge.svg?branch=main
:target: https://github.com/numpy/numpydoc/actions/workflows/test.yml
This package provides the ``numpydoc`` Sphinx extension for handling
docstrings formatted according to the NumPy documentation format.
The extension also adds the code description directives
``np:function``, ``np-c:function``, etc.
numpydoc requires Python 3.8+ and sphinx 5+.
For usage information, please refer to the `documentation
<https://numpydoc.readthedocs.io/>`_.
The `numpydoc docstring guide
<https://numpydoc.readthedocs.io/en/latest/format.html>`_ explains how
to write docs formatted for this extension, and the `user guide
<https://numpydoc.readthedocs.io>`_ explains how to use it with Sphinx.
Raw data
{
"_id": null,
"home_page": "",
"name": "numpydoc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "sphinx,numpy",
"author": "",
"author_email": "Pauli Virtanen and others <pav@iki.fi>",
"download_url": "https://files.pythonhosted.org/packages/5f/ed/5ca4b2e90f4b0781f5fac49cdb2947cf719b6d289eedb67e8b1a63d019e3/numpydoc-1.6.0.tar.gz",
"platform": null,
"description": "=====================================\nnumpydoc -- Numpy's Sphinx extensions\n=====================================\n\n.. image:: https://readthedocs.org/projects/numpydoc/badge/?version=latest\n :alt: Documentation Status\n :scale: 100%\n :target: https://numpydoc.readthedocs.io/en/latest/\n\n.. image:: https://codecov.io/gh/numpy/numpydoc/branch/main/graph/badge.svg\n :target: https://app.codecov.io/gh/numpy/numpydoc/branch/main\n\n.. image:: https://github.com/numpy/numpydoc/actions/workflows/test.yml/badge.svg?branch=main\n :target: https://github.com/numpy/numpydoc/actions/workflows/test.yml\n\nThis package provides the ``numpydoc`` Sphinx extension for handling\ndocstrings formatted according to the NumPy documentation format.\nThe extension also adds the code description directives\n``np:function``, ``np-c:function``, etc.\n\nnumpydoc requires Python 3.8+ and sphinx 5+.\n\nFor usage information, please refer to the `documentation\n<https://numpydoc.readthedocs.io/>`_.\n\nThe `numpydoc docstring guide\n<https://numpydoc.readthedocs.io/en/latest/format.html>`_ explains how\nto write docs formatted for this extension, and the `user guide\n<https://numpydoc.readthedocs.io>`_ explains how to use it with Sphinx.\n",
"bugtrack_url": null,
"license": "Copyright (C) 2008-2023 Stefan van der Walt <stefan@mentat.za.net>, Pauli Virtanen <pav@iki.fi> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Sphinx extension to support docstrings in Numpy format",
"version": "1.6.0",
"project_urls": {
"Homepage": "https://numpydoc.readthedocs.io",
"Source": "https://github.com/numpy/numpydoc/"
},
"split_keywords": [
"sphinx",
"numpy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9c9409c437fd4a5fb5adf0468c0865c781dbc11d399544b55f1163d5d4414afb",
"md5": "851557437e256b1489e40579397e14d3",
"sha256": "b6ddaa654a52bdf967763c1e773be41f1c3ae3da39ee0de973f2680048acafaa"
},
"downloads": -1,
"filename": "numpydoc-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "851557437e256b1489e40579397e14d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 61722,
"upload_time": "2023-09-26T00:24:32",
"upload_time_iso_8601": "2023-09-26T00:24:32.176101Z",
"url": "https://files.pythonhosted.org/packages/9c/94/09c437fd4a5fb5adf0468c0865c781dbc11d399544b55f1163d5d4414afb/numpydoc-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5fed5ca4b2e90f4b0781f5fac49cdb2947cf719b6d289eedb67e8b1a63d019e3",
"md5": "227e5a257f4bfe488a257d963c2df5bc",
"sha256": "ae7a5380f0a06373c3afe16ccd15bd79bc6b07f2704cbc6f1e7ecc94b4f5fc0d"
},
"downloads": -1,
"filename": "numpydoc-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "227e5a257f4bfe488a257d963c2df5bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 85475,
"upload_time": "2023-09-26T00:24:33",
"upload_time_iso_8601": "2023-09-26T00:24:33.820913Z",
"url": "https://files.pythonhosted.org/packages/5f/ed/5ca4b2e90f4b0781f5fac49cdb2947cf719b6d289eedb67e8b1a63d019e3/numpydoc-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 00:24:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "numpy",
"github_project": "numpydoc",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"circle": true,
"lcname": "numpydoc"
}
