Requirements and Installation

The latest stable version can be always found on PyPI.

Since it’s a stand-alone tool, I recommend to install it using pipsi.

Of course, you can also install it as usual using pip:

$ pip install --user doc2dash

doc2dash runs on Python 2.7, and 3.3+, and PyPy. Both Linux and OS X are supported although certain features are only available on OS X.

Note

For best performance when converting large pieces documentation, I strongly recommend using PyPy as the interpreter of choice.

Viewer

To view the results, you will need a docset viewer, the most commonly known being Dash.app for OS X.

Other alternatives have been developed in cooperation with Dash.app’s developer Kapeli:

doc2dash is only tested against the original Dash.app though.