https://github.com/chilipp/docrep
A Python Module for intelligent reuse of docstrings
https://github.com/chilipp/docrep
Last synced: 3 months ago
JSON representation
A Python Module for intelligent reuse of docstrings
- Host: GitHub
- URL: https://github.com/chilipp/docrep
- Owner: Chilipp
- License: apache-2.0
- Created: 2016-08-20T12:45:33.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-02-16T08:57:05.000Z (over 4 years ago)
- Last Synced: 2025-02-27T07:50:42.505Z (3 months ago)
- Language: Python
- Size: 103 KB
- Stars: 31
- Watchers: 2
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
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.