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.6.tar.gz (4.4 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib.divparams-0.0.6.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib.divparams-0.0.6.tar.gz
Algorithm Hash digest
SHA256 6003d91af10bc27ea78c707cb4cbdf25d3849623577cbd32bc9d6afb1caf8d84
MD5 1d57a0bd3c1070cc6be31b8edcfb2d5f
BLAKE2b-256 1f157f42ebf9ba4d527cf26154bed3786bb81c6b9abd2cd5fe21e09105a07629

See more details on using hashes here.

Supported by

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