sphinxcontrib_dashbuilder generate a ‘Documentation Set’ intended to be used with the dash API browser from a Sphinx documentation.
You can read the ‘Documentation Set’ style document by using dash API browser.
This extension has been inspired by doc2dash
Features
Implemented:
Generate a ‘Documentation Set’ for dash API browser.
Not Implemented yet:
Keyword indexing with Sphinx i18n translated documentation.
Disable sidebar
Table of contents support http://kapeli.com/docsets#tableofcontents
Install
$ pip install sphinxcontrib-dashbuilder
If you wanto to use unrelease version, you can install from repository:
$ pip install -e hg+https://bitbucket.org/shimizukawa/sphinxcontrib-dashbuilder
Configuration
conf.py configuration values:
- dash_name:
(optional) name for docset explicitly. default is same as project.
- dash_icon_file:
(optional) PNG file path for docset icon.
- dash_translator_class:
(optional) A string with the fully-qualified name of a Dash Translator class, that is, a subclass of Sphinx’ DashTranslator, that is used to translate document trees to HTML for Dash. Default is None (use the builtin translator).
conf.py example:
extensions = ['sphinxcontrib.dashbuilder'] dash_name = 'Python_3' dash_icon_file = '_static/python.png'
Run
run:
$ sphinx-build -b dash [source] [outdir]
and you get dash documentation set under ‘_build/dash/’ directory.
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-dashbuilder 0.1.0
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 | |
|---|---|---|---|---|
| sphinxcontrib-dashbuilder-0.1.0.zip | 16.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 24.7 kB
Release files / sphinxcontrib-dashbuilder-0.1.0.zip
| Download URL | sphinxcontrib-dashbuilder-0.1.0.zip |
|---|---|
| Size | 16.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3d9d624df3a3b536a290ce0231cdd0dfee6aa48553ac4a3e6a5c278b6fc9636a
|
|
BLAKE2b-256 checksum How to use checksums |
0cee49200a707ab595932a2273d6d55091fbf66f3c665db4485bf77f6889305c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl
| Download URL | sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl |
|---|---|
| Size | 8.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
227a6e62bd37d90181a617024c68297ed87a6b5c7abe9d5313a90c9e2e836d9d
|
|
BLAKE2b-256 checksum How to use checksums |
2262543f4c1b9d5db9c4222e86c6cb2eb6c8c0bac3803f987082cf5bb46e95ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinxcontrib-dashbuilder 0.1.0
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.
