Convert docs to docsets.
Project description
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:
Feel free to help adding more!
Usage
The usage is a simple as:
$ doc2dash <docdir>
doc2dash will create a new directory called “<docdir>.docset” in the current directory containing a dash-compatible docset with a SQLite index.
When finished, the docset can be imported into dash.
Full usage:
usage: doc2dash [-h] [--force] [--name NAME] [--version] source
Convert docs to docsets.
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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file doc2dash-0.2.2.tar.gz.
File metadata
- Download URL: doc2dash-0.2.2.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 48aecd3d634162560e1dc9778071485b1ea57094ace28f56b76f6045c9334dc6 |
|
| MD5 | 70b0f1f108f801b7e34d611429681d17 |
|
| BLAKE2b-256 | 1400798a1a2de6f2728211167b420ef21a6a64e613925b17c1c8cb556e2081ff |
