docrep - A Python Module for intelligent reuse of docstrings
============================================================
.. list-table::
:stub-columns: 1
:widths: 10 90
* - docs
- |docs|
* - tests
- |travis| |coveralls|
* - package
- |version| |conda| |supported-versions| |supported-implementations|
.. |docs| image:: http://readthedocs.org/projects/docrep/badge/?version=latest
:alt: Documentation Status
:target: http://docrep.readthedocs.io/en/latest/?badge=latest
.. |travis| image:: https://travis-ci.org/Chilipp/docrep.svg?branch=master
:alt: Travis
:target: https://travis-ci.org/Chilipp/docrep
.. |coveralls| image:: https://coveralls.io/repos/github/Chilipp/docrep/badge.svg?branch=master
:alt: Coverage
:target: https://coveralls.io/github/Chilipp/docrep?branch=master
.. |version| image:: https://img.shields.io/pypi/v/docrep.svg?style=flat
:alt: PyPI Package latest release
:target: https://pypi.python.org/pypi/docrep
.. |conda| image:: https://anaconda.org/conda-forge/docrep/badges/installer/conda.svg
:alt: conda
:target: https://anaconda.org/conda-forge/docrep
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/docrep.svg?style=flat
:alt: Supported versions
:target: https://pypi.python.org/pypi/docrep
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/docrep.svg?style=flat
:alt: Supported implementations
:target: https://pypi.python.org/pypi/docrep
What's this?
------------
Welcome to the **doc**\ umentation **rep**\ etition module **docrep**! This
module targets developers that develop complex and nested Python APIs and
helps them to create a well-documented piece of software.
See the `documentation on readthedocs`_ for a small tutorial.
.. _documentation on readthedocs: http://docrep.readthedocs.io/en/latest/
Installation
------------
Installation simply goes via pip::
$ pip install docrep
or via conda_::
$ conda install -c conda-forge docrep
or from the source on github_ via::
$ python setup.py install
.. _conda: https://conda.io/docs/
.. _github: https://github.com/Chilipp/docrep
Disclaimer
----------
Copyright 2021 Philipp S. Sommer, Helmholtz-Zentrum Geesthacht
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Raw data
{
"_id": null,
"home_page": "https://github.com/Chilipp/docrep",
"name": "docrep",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "docstrings docs docstring napoleon numpy reStructured text",
"author": "Philipp S. Sommer",
"author_email": "philipp.sommer@hzg.de",
"download_url": "https://files.pythonhosted.org/packages/44/8e/250fab1cafeea43f4eb11f1d64cd6313f639965ff62cb0d9da3883655781/docrep-0.3.2.tar.gz",
"platform": "",
"description": "docrep - A Python Module for intelligent reuse of docstrings\n============================================================\n\n.. list-table::\n :stub-columns: 1\n :widths: 10 90\n\n * - docs\n - |docs|\n * - tests\n - |travis| |coveralls|\n * - package\n - |version| |conda| |supported-versions| |supported-implementations|\n\n.. |docs| image:: http://readthedocs.org/projects/docrep/badge/?version=latest\n :alt: Documentation Status\n :target: http://docrep.readthedocs.io/en/latest/?badge=latest\n\n.. |travis| image:: https://travis-ci.org/Chilipp/docrep.svg?branch=master\n :alt: Travis\n :target: https://travis-ci.org/Chilipp/docrep\n\n.. |coveralls| image:: https://coveralls.io/repos/github/Chilipp/docrep/badge.svg?branch=master\n :alt: Coverage\n :target: https://coveralls.io/github/Chilipp/docrep?branch=master\n\n.. |version| image:: https://img.shields.io/pypi/v/docrep.svg?style=flat\n :alt: PyPI Package latest release\n :target: https://pypi.python.org/pypi/docrep\n\n.. |conda| image:: https://anaconda.org/conda-forge/docrep/badges/installer/conda.svg\n :alt: conda\n :target: https://anaconda.org/conda-forge/docrep\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/docrep.svg?style=flat\n :alt: Supported versions\n :target: https://pypi.python.org/pypi/docrep\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/docrep.svg?style=flat\n :alt: Supported implementations\n :target: https://pypi.python.org/pypi/docrep\n\n\nWhat's this?\n------------\nWelcome to the **doc**\\ umentation **rep**\\ etition module **docrep**! This\nmodule targets developers that develop complex and nested Python APIs and\nhelps them to create a well-documented piece of software.\n\nSee the `documentation on readthedocs`_ for a small tutorial.\n\n.. _documentation on readthedocs: http://docrep.readthedocs.io/en/latest/\n\nInstallation\n------------\nInstallation simply goes via pip::\n\n $ pip install docrep\n\nor via conda_::\n\n $ conda install -c conda-forge docrep\n\nor from the source on github_ via::\n\n $ python setup.py install\n\n.. _conda: https://conda.io/docs/\n.. _github: https://github.com/Chilipp/docrep\n\n\nDisclaimer\n----------\nCopyright 2021 Philipp S. Sommer, Helmholtz-Zentrum Geesthacht\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python package for docstring repetition",
"version": "0.3.2",
"split_keywords": [
"docstrings",
"docs",
"docstring",
"napoleon",
"numpy",
"restructured",
"text"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ef7ee1e048d37c790a19891cb117a04a",
"sha256": "ed8a17e201abd829ef8da78a0b6f4d51fb99a4cbd0554adbed3309297f964314"
},
"downloads": -1,
"filename": "docrep-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "ef7ee1e048d37c790a19891cb117a04a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33197,
"upload_time": "2021-02-16T09:01:50",
"upload_time_iso_8601": "2021-02-16T09:01:50.183297Z",
"url": "https://files.pythonhosted.org/packages/44/8e/250fab1cafeea43f4eb11f1d64cd6313f639965ff62cb0d9da3883655781/docrep-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-02-16 09:01:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Chilipp",
"github_project": "docrep",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "docrep"
}
JSON
