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 Dash.app API browser for macOS or one of its many free clones for all relevant platforms.

If you’ve never heard of Dash.app 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 Dash.app releases by setting the plist key DashDocSetDeclaredInStyle to originalName.

Full changelog.

Authors

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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file doc2dash-2.4.0.tar.gz.

File metadata

  • Download URL: doc2dash-2.4.0.tar.gz
  • Upload date:
  • Size: 39.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for doc2dash-2.4.0.tar.gz
Algorithm Hash digest
SHA256 a6a4a0a02bc80e87ef20935baf901c933a3ae0d085cfcff076ebaecccfcda7cf
MD5 f7e462c8f28d1de8be239ac74a9e07e1
BLAKE2b-256 1f470453a028a13e010cb83f4023afa3ca7fa38e914fce6eabecc613fbe96e5d

See more details on using hashes here.

File details

Details for the file doc2dash-2.4.0-py2.py3-none-any.whl.

File metadata

  • Download URL: doc2dash-2.4.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for doc2dash-2.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5ebc1431a66dc7c381a030ceea79327a25612a7f75650254bdbb64c00a97acd0
MD5 8c4a72ed700cf6fc8772421f22a4ac6c
BLAKE2b-256 5eddc5a668d7c0b977c2fe36ae6d66307f8bd51aaa2b6b76a92c30979449c135

See more details on using hashes here.

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