param_docs

https://img.shields.io/pypi/v/param_docs.svg https://img.shields.io/travis/Jhsmit/param_docs.svg Documentation Status

Test package for generating docs from param.Parameterized classes

Features

This an example project of how to customize sphinx autodoc generation from param.Parameterized classes. The aim is to generate docs which are informative for users of the web application, where components are by param.Parameterized subclass ‘controllers’. Numpydoc style docstrings are assumed for normal (non Parameterized) classes, which is supressed for Parameterized classes.

Credits

The code for formatting docstrings is based on Pyviz’ nbsite paramdoc

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.