doc2dash: Create docsets for dash

doc2dash is a MIT licensed extensible Documentation Set generator intended to be used with the dash API browser for OS X.

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:

Sphinx (nearly every single Python project out there)
pydoctor (Twisted!)

Feel free to help adding more! While doc2dash is implemented in Python, the scope for the supported documentation types is unlimited. So go on and submit a parser for your favourite Ruby, Haskell, Lisp, Erlang, JavaScript, … format!

Usage

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.

Full usage:

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

Installation

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

Metadata

Release files for doc2dash 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for doc2dash 0.3.0
File	Size	Uploaded
doc2dash-0.3.0.tar.gz	8.8 kB	Jun 28, 2012	Details

Release files / doc2dash-0.3.0.tar.gz

Download URL	doc2dash-0.3.0.tar.gz
Size	8.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`b399b393261fc27c2839bddc2ac13175a7a76220bca686a53692d368961238b9`
BLAKE2b-256 checksum How to use checksums	`cf6aced4b54fbdf80c3c700d590db92c24a05ee35e546702a990553aa6ece20f`
Upload date	Jun 28, 2012
Uploaded using Trusted Publishing? What is trusted publishing?	No