Metadata-Version: 2.1
Name: flake8-rst-docparams
Version: 1.0.7
Summary: Check for reStructuredText function parameter documentation
Home-page: https://bitbucket.org/jakobsg/flake8-rst-docparams
Author: Jakob Simon-Gaarde
Author-email: jakobsg@gmail.com
Classifier: Intended Audience :: Developers
Classifier: Framework :: Flake8
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance

README
======

Flake8 check for missing parameter RST documentation in Python based
projects.

Install
~~~~~~~

From source
^^^^^^^^^^^

::

   git clone git@bitbucket.org:jakobsg/flake8-rst-docparams.git
   cd flake8-rst-docparams.git
   python3 setup.py install

From PyPi
^^^^^^^^^

::

   pip install flake8-rst-docparams

Setup with Tox
~~~~~~~~~~~~~~

::

   [testenv:flake8]
   basepython = python3
   skip_install = true
   deps =
       flake8
       flake8-rst-docparams
   commands =
       flake8
