doc2dash is a an extensible Documentation Set generator intended to be used with the dash API browser for OS X and UNIX.
It’s proudly written in Python 3.
Supported input types
Currently, the following source types are supported:
- Sphinx (nearly every single Python project out there)
- pydoctor (Twisted)
Feel free to help adding more!
The usage is a simple as:
doc2dash < docdir >
doc2dash will create a new directory called “.docset” in the current directory containing a dash-compatible docset with a SQLite index.
When finished, the docset can be imported into dash.
usage: doc2dash [-h] [--force] [--name NAME] [--version] source
Convert docs to docsets.
source Source directory containing API documentation in a
-h, --help show this help message and exit
--force, -f force overwriting if destination already exists
--name NAME, -n NAME name docset explicitly
--version show program's version number and exit
The latest stable version can be always found on PyPI and can therefore be installed using a simple:
pip-3.2 install --user doc2dash
The easiest way known to me to get Python 3.2 on OS X is using homebrew:
brew install python3
The installation of pip should be as easy as:
curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python3.2