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

Features

Implemented:

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

Not Implemented yet:

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.

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-dashbuilder-0.1.0.zip (16.5 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file sphinxcontrib-dashbuilder-0.1.0.zip.

File metadata

File hashes

Hashes for sphinxcontrib-dashbuilder-0.1.0.zip
Algorithm Hash digest
SHA256 3d9d624df3a3b536a290ce0231cdd0dfee6aa48553ac4a3e6a5c278b6fc9636a
MD5 82d90986540b6409b69b629423630b44
BLAKE2b-256 0cee49200a707ab595932a2273d6d55091fbf66f3c665db4485bf77f6889305c

See more details on using hashes here.

File details

Details for the file sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_dashbuilder-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 227a6e62bd37d90181a617024c68297ed87a6b5c7abe9d5313a90c9e2e836d9d
MD5 60a2851cf5d438ca1f7f5d93aaa0f2e8
BLAKE2b-256 2262543f4c1b9d5db9c4222e86c6cb2eb6c8c0bac3803f987082cf5bb46e95ad

See more details on using hashes here.

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