Sphinx builder extension to generate a 'Documentation Set' for `dash API browser`.
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
Not Implemented yet:
$ 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
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.|
|(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).|
extensions = ['sphinxcontrib.dashbuilder'] dash_name = 'Python_3' dash_icon_file = '_static/python.png'
$ sphinx-build -b dash [source] [outdir]
and you get dash documentation set under ‘_build/dash/’ directory.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Checksum SHA256 Checksum Help||Version||File Type||Upload Date|
|sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl (8.2 kB) Copy SHA256 Checksum SHA256||3.3||Wheel||May 24, 2014|
|sphinxcontrib-dashbuilder-0.1.0.zip (16.5 kB) Copy SHA256 Checksum SHA256||–||Source||May 24, 2014|