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
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
Metadata
Release files for sphinxcontrib.divparams 0.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinxcontrib.divparams-0.0.6.tar.gz | 4.4 kB | Without provenance | Details for sphinxcontrib.divparams-0.0.6.tar.gz |
Release files / sphinxcontrib.divparams-0.0.6.tar.gz
| Download URL | sphinxcontrib.divparams-0.0.6.tar.gz |
|---|---|
| Size | 4.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6003d91af10bc27ea78c707cb4cbdf25d3849623577cbd32bc9d6afb1caf8d84
|
|
BLAKE2b-256 checksum How to use checksums |
1f157f42ebf9ba4d527cf26154bed3786bb81c6b9abd2cd5fe21e09105a07629
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Python-urllib/2.7
|
Security for sphinxcontrib.divparams 0.0.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.