Metadata-Version: 2.1
Name: docrep
Version: 0.3.2
Summary: Python package for docstring repetition
Home-page: https://github.com/Chilipp/docrep
Author: Philipp S. Sommer
Author-email: philipp.sommer@hzg.de
License: Apache-2.0
Project-URL: Documentation, https://docrep.readthedocs.io
Project-URL: Source, https://github.com/Chilipp/docrep
Project-URL: Tracker, https://github.com/Chilipp/docrep/issues
Description: 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.
        
Keywords: docstrings docs docstring napoleon numpy reStructured text
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Documentation
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Description-Content-Type: text/x-rst
