https://github.com/jhsmit/param_docs
Example of param sphinx docstrings
https://github.com/jhsmit/param_docs
Last synced: about 1 month ago
JSON representation
Example of param sphinx docstrings
- Host: GitHub
- URL: https://github.com/jhsmit/param_docs
- Owner: Jhsmit
- License: mit
- Created: 2020-09-14T12:32:49.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-28T12:37:27.000Z (over 4 years ago)
- Last Synced: 2025-02-10T02:46:47.624Z (3 months ago)
- Language: Python
- Homepage: https://param-doc.readthedocs.io
- Size: 36.1 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
==========
param_docs
==========
.. image:: https://img.shields.io/pypi/v/param_docs.svg
:target: https://pypi.python.org/pypi/param_doc
.. image:: https://img.shields.io/travis/Jhsmit/param_docs.svg
:target: https://travis-ci.com/Jhsmit/param_docs
.. image:: https://readthedocs.org/projects/param-doc/badge/?version=latest
:target: https://param-doc.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Test package for generating docs from param.Parameterized classes
* Free software: MIT license
* Documentation: https://param-doc.readthedocs.io.
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.
.. _paramdoc: https://github.com/pyviz-dev/nbsite/blob/master/nbsite/paramdoc.py
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage