Skip to main content

Sphinx builder extension to generate a 'Documentation Set' for `dash API browser`.

Project description

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.

  • For Mac OS X users: dash

  • For Windows or Linux users: Zeal

This extension has been inspired by doc2dash



  • Generate a ‘Documentation Set’ for dash API browser.

Not Implemented yet:


$ pip install sphinxcontrib-dashbuilder

If you wanto to use unrelease version, you can install from repository:

$ pip install -e hg+

Configuration configuration values:


(optional) name for docset explicitly. default is same as project.


(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). example:

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.

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 (16.5 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl (8.2 kB view hashes)

Uploaded Python 2 Python 3

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