Skip to main content

Convert docs to the docset format.

Project description

doc2dash is an MIT-licensed extensible Documentation Set generator intended to be used with the API browser for macOS or one of its many free clones for all relevant platforms.

If you’ve never heard of and its likes, you’re missing out: together with 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.

Release Information

2.4.0 (2021-11-16)

This version dropped every Python version older than 3.8. Please use 2.3 if you need to run doc2dash on legacy Python versions.

  • Better display names with Sphinx v2 inventories. #101

  • Added new intersphinx types:

    • cmdoption (deprecated alias for option)

    • doc

    • label

    • property

    • protocol

    • setting

    • term

    Re-indexing your documentation may add new index entries!

  • zope.interface is not a dependency anymore.

  • colorama is only a dependency on Windows now.

  • Work around a display bug in older releases by setting the plist key DashDocSetDeclaredInStyle to originalName.

Full changelog.


doc2dash is written and maintained by Hynek Schlawack.

The development is kindly supported by Variomedia AG.

A full list of contributors can be found on GitHub’s overview.

Project details

Download files

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

Source Distribution

doc2dash-2.4.0.tar.gz (39.7 kB view hashes)

Uploaded Source

Built Distribution

doc2dash-2.4.0-py2.py3-none-any.whl (13.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page