README.rst

Parameters list as <div>'s in HTML generated by Sphinx

This package is a simple Sphinx extension named divparams, which was created to bring another style to the lists of function parameters and return values in HTML files generated by Sphinx.

To make use of the dirty hack this extension provides, first, install its package from PyPI:

$ sudo pip install sphinxcontrib.divparams

and then import it into your Sphinx's conf.py and add its parameters to the lists of extensions, templates directories, and static directories:

import sphinxcontrib.divparams as divparams
extensions       = [..., 'sphinxcontrib.divparams']
templates_path   = [..., divparams.get_templates_path()]
html_static_path = [..., divparams.get_static_path()]

divparams_enable_postprocessing = True

See following links for more information. There is a broader description and a couple of nice pictures on the standalone documentation page.

• Repository: https://github.com/firegurafiku/sphinxcontrib-divparams
• PyPI: https://pypi.python.org/pypi/sphinxcontrib.divparams
• Documentation: https://pythonhosted.org/sphinxcontrib.divparams/
• Travis-CI: https://travis-ci.org/firegurafiku/sphinxcontrib-divparams
• Reddit thread: https://www.reddit.com/r/Python/comments/3se07g
• Original SO question: http://stackoverflow.com/questions/33296824