Procedure to check for valid Sphinx ReST docstrings
Project description
docstringtest
-------------
|build-status| |coverage| |docs| |license|
.. |build-status| image:: https://travis-ci.org/jakelever/docstringtest.svg?branch=master
:target: https://travis-ci.org/jakelever/docstringtest
:alt: Travis CI status
.. |coverage| image:: https://coveralls.io/repos/github/jakelever/docstringtest/badge.svg?branch=master
:target: https://coveralls.io/github/jakelever/docstringtest?branch=master
:alt: Coverage status
.. |docs| image:: https://readthedocs.org/projects/docstringtest/badge/
:target: http://docstringtest.readthedocs.io/
:alt: Documentation status
.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT license
docstringtest is a small package for regression testing of docstrings in Python code. It checks that all appropriate methods and functions are using ReST docstrings with parameter information so that nice documentation can be generated. This format looks like:
.. code-block:: python
def example_function(varA,varB):
"""
This function does nothing
:param varA: The first variable
:param varB: The second variable
:type varA: The type of the first variable
:type varB: The type of the second variable
"""
pass
It makes it easy to check that the docstrings match with the current parameters so that documentation doesn't become out-of-step with the code.
-------------
|build-status| |coverage| |docs| |license|
.. |build-status| image:: https://travis-ci.org/jakelever/docstringtest.svg?branch=master
:target: https://travis-ci.org/jakelever/docstringtest
:alt: Travis CI status
.. |coverage| image:: https://coveralls.io/repos/github/jakelever/docstringtest/badge.svg?branch=master
:target: https://coveralls.io/github/jakelever/docstringtest?branch=master
:alt: Coverage status
.. |docs| image:: https://readthedocs.org/projects/docstringtest/badge/
:target: http://docstringtest.readthedocs.io/
:alt: Documentation status
.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT license
docstringtest is a small package for regression testing of docstrings in Python code. It checks that all appropriate methods and functions are using ReST docstrings with parameter information so that nice documentation can be generated. This format looks like:
.. code-block:: python
def example_function(varA,varB):
"""
This function does nothing
:param varA: The first variable
:param varB: The second variable
:type varA: The type of the first variable
:type varB: The type of the second variable
"""
pass
It makes it easy to check that the docstrings match with the current parameters so that documentation doesn't become out-of-step with the code.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
docstringtest-0.1.0.tar.gz
(3.2 kB
view hashes)
Built Distribution
Close
Hashes for docstringtest-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58b906fe5fb3b982942388fe280465275c4a6aba9006ec26a9bff1419599c266 |
|
MD5 | 70d440ad6ea282d5df3dfdcc27fe60f6 |
|
BLAKE2b-256 | 39fdff1b7dfe9061a1954bc801d6b68b0e868ae0ab4d685b25ca6129330aa1e2 |