doc2dash

doc2dash is a handy tool that helps you create Documentation Sets for the Dash API browser, which works great on OS X and UNIX systems. If you're into coding, you'll love how easy it is to generate docs with this!

What Makes doc2dash Awesome?

This software is proudly built using Python 3, making it flexible and reliable. Right now, it supports some popular source types:

• Sphinx (which many Python projects use)


• pydoctor (from the Twisted framework)

If you have other sources in mind, feel free to pitch in and help add more!

How to Use doc2dash

The usage is super straightforward. You just run this command:

doc2dash < docdir >

This will create a new folder called “.docset” right where you are. Inside that folder, you'll find everything you need for a Dash-compatible documentation set, including a SQLite index.

Importing Your Docset

Once you're done creating your docset, you can easily import it into the Dash app.

Full Command Usage

usage: doc2dash [-h] [--force] [--name NAME] [--version] source

This lets you convert documentation into docsets. Here’s what each part means:

• source: This is the directory where your API docs live.

Optional Arguments:

• -h, --help: Shows help info and exits.


• --force, -f: Overwrites existing files if needed.


• --name NAME, -n NAME: Lets you name the docset yourself.


• --version: Displays the program's version number.

Your Next Steps!

You can always find the latest stable version of doc2dash on PyPI. To install it, just run this simple command:

 pip-3.2 install --user doc2dash

If you're looking for an easy way to get Python 3.2 on OS X, I recommend using Homebrew:

 brew install python3

The installation of pip should be as simple as running this command:

 curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python3.2