.. image:: https://readthedocs.org/projects/doc2dash/badge/?version=stable :target: https://doc2dash.readthedocs.io/en/stable/?badge=stable :alt: Documentation Status
.. image:: https://github.com/hynek/doc2dash/workflows/CI/badge.svg?branch=main :target: https://github.com/hynek/doc2dash/actions?workflow=CI :alt: CI Status
.. image:: https://codecov.io/github/hynek/doc2dash/branch/main/graph/badge.svg :target: https://codecov.io/github/hynek/doc2dash :alt: Test Coverage
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black :alt: Code style: black
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 and its likes, you’re missing out:
doc2dash it’s all your API documentation at your fingertips – even when you're offline!
doc2dash\ ’s documentation lives at
Read the Docs, the code on GitHub.
It’s tested on Python 3.8+ (the fully functional 2.x release line
on PyPI_ also supports Python 2.7, 3.4–3.6, and PyPy).
Both Linux and macOS are tested although certain features are only available on macOS.
Documentation Set: https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/Documentation_Sets/010-Overview_of_Documentation_Sets/docset_overview.html#//apple_ref/doc/uid/TP40005266-CH13-SW6
Read the Docs: https://doc2dash.readthedocs.io/
on PyPI: https://pypi.org/project/doc2dash/#history