Skip to main content

Converts parameter tables in HTML documentation generated by Sphinx into <div>'s.

Project description

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.

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

sphinxcontrib.divparams-0.0.5.tar.gz (4.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page