Convert docs to docsets.
If you’ve never hear of dash, you’re missing out: Together with doc2dash it’s all your API documentation at your fingertips!
doc2dash is proudly written in Python 3 (but seems to work with 2.7 too at the moment).
Supported input types
Currently, the following source types are supported:
The usage is as simple as:
$ doc2dash -A <docdir>
doc2dash will create a new directory called “<docdir>.docset” in ~/Library/Application Support/doc2dash/DocSets containing a dash-compatible docset with a SQLite index. When finished, the docset is automatically added to dash.
usage: doc2dash [-h] [--force] [--name NAME] [--version] [--quiet] [--verbose] [--destination DESTINATION] [--add-to-dash] [-A] source positional arguments: source Source directory containing API documentation in a supported format. optional arguments: -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 --quiet, -q limit output to errors and warnings --verbose, -v be verbose --destination DESTINATION, -d DESTINATION destination directory for docset (default is current), ignored if -A is specified --add-to-dash, -a automatically add resulting docset to dash -A create docset in doc2dash's default directory and add resulting docset to dash --icon ICON, -i ICON add PNG icon to docset
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
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size doc2dash-0.3.1.tar.gz (8.8 kB)||File type Source||Python version None||Upload date||Hashes View hashes|