doc2dash Convert docs to docsets
Download

doc2dash Ranking & Summary

doc2dash Tags

converter Docs

doc2dash Description

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 typesCurrently, the following source types are supported:- Sphinx (nearly every single Python project out there)- pydoctor (Twisted)Feel free to help adding more!UsageThe 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.Full usage:usage: doc2dash sourceConvert 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 exitInstallationThe latest stable version can be always found on PyPI and can therefore be installed using a simple: pip-3.2 install --user doc2dashThe easiest way known to me to get Python 3.2 on OS X is using homebrew: brew install python3The installation of pip should be as easy as: curl https://raw.github.com/pypa/pip/master/contrib/get-pip.py | python3.2Product's homepage

doc2dash Related Software