shimizukawa / sphinxcontrib-dashbuilder Goto Github PK

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

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

$ 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:

conf.py example:

extensions = ['sphinxcontrib.dashbuilder']

dash_name = 'Python_3'
dash_icon_file = '_static/python.png'

run:

$ sphinx-build -b dash [source] [outdir]

and you get dash documentation set under '_build/dash/' directory.

• Documentation: http://pythonhosted.org//sphinxcontrib-dashbuilder/
• Repository: http://bitbucket.org/shimizukawa/sphinxcontrib-dashbuilder
• Download URL: http://pypi.python.org/pypi/sphinxcontrib-dashbuilder

BSD License.

• First release
• Generate a 'Documentation Set' for dash API browser.