Convert docs to Dash.app
.. image:: https://readthedocs.org/projects/doc2dash/badge/?version=stable :target: https://doc2dash.readthedocs.io/en/stable/?badge=stable :alt: Documentation Status
.. image:: https://travis-ci.org/hynek/doc2dash.svg?branch=master :target: https://travis-ci.org/hynek/doc2dash
.. image:: https://codecov.io/github/hynek/doc2dash/branch/master/graph/badge.svg :target: https://codecov.io/github/hynek/doc2dash :alt: Test Coverage
.. begin
doc2dash
is an MIT-licensed extensible Documentation Set
_ generator intended to be used with the Dash.app
_ API browser for macOS or one of its many free clones <https://doc2dash.readthedocs.io/en/latest/installation.html#viewer>
_ for all relevant platforms.
If you’ve never heard of Dash.app, you’re missing out:
together with doc2dash
it’s all your API documentation at your fingertips!
doc2dash
\ ’s documentation lives at Read the Docs
, the code on GitHub.
It’s tested on Python 2.7, 3.4+, and PyPy.
Both Linux and macOS are tested although certain features are only available on macOS.
.. Documentation Set
: https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/DocumentationSets/010-OverviewofDocumentationSets/docsetoverview.html#//apple_ref/doc/uid/TP40005266-CH13-SW6
.. _Dash.app
: https://kapeli.com/dash/
.. _Read the Docs
: https://doc2dash.readthedocs.io/
.. _GitHub
: https://github.com/hynek/doc2dash
InterSphinxParser
is now open to extension.
#59 <https://github.com/hynek/doc2dash/pull/59>
_--parser
option to force the use of a custom parser class.
#60 <https://github.com/hynek/doc2dash/pull/60>
_Full changelog <https://doc2dash.readthedocs.io/en/stable/changelog.html>
_.
doc2dash
is written and maintained by Hynek Schlawack.
The development is kindly supported by Variomedia AG <https://www.variomedia.de/>
_.
A full list of contributors can be found on GitHub's overview <https://github.com/hynek/doc2dash/graphs/contributors>
_.