Skip to main content

Convert docs to Dash.app's docset format.

Project description

https://secure.travis-ci.org/hynek/doc2dash.png

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 heard of dash, you’re missing out: Together with doc2dash it’s all your API documentation at your fingertips!

Supported input types

Currently, the following source types are supported:

  • Sphinx’s HTML output (nearly every single Python project out there)
  • pydoctor’s HTML output (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
  --index-page INDEX_PAGE, -I INDEX_PAGE
                          set index html file for docset

Installation

The latest stable version can be always found on PyPI and can therefore be installed using a simple:

$ pip install --user doc2dash

If you haven’t pip yet, installation should be as easy as:

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

doc2dash runs on Python 2.7, 3.2, and 3.3.

Project details


Release history Release notifications

History Node

2.2.0

History Node

2.1.0

History Node

2.0.2

History Node

2.0.1

History Node

2.0.0

History Node

1.2.1

This version
History Node

1.2.0

History Node

1.1.0

History Node

1.0.0

History Node

0.3.1

History Node

0.3.0

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
doc2dash-1.2.0-py2.py3-none-any.whl (15.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jan 7, 2014
doc2dash-1.2.0.tar.gz (11.7 kB) Copy SHA256 hash SHA256 Source None Jan 7, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page