{"id":13483513,"url":"https://github.com/hynek/doc2dash","last_synced_at":"2025-05-15T17:05:33.959Z","repository":{"id":3553592,"uuid":"4614506","full_name":"hynek/doc2dash","owner":"hynek","description":"Create docsets for Dash.app-compatible API browsers.","archived":false,"fork":false,"pushed_at":"2025-05-01T09:01:21.000Z","size":1366,"stargazers_count":581,"open_issues_count":6,"forks_count":37,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-05-01T10:19:31.618Z","etag":null,"topics":["converter","documentation","documentation-tool","mkdocs","mkdocstrings","pydoctor","python","sphinx"],"latest_commit_sha":null,"homepage":"https://doc2dash.hynek.me/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hynek.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"hynek"}},"created_at":"2012-06-10T11:16:50.000Z","updated_at":"2025-05-01T09:01:13.000Z","dependencies_parsed_at":"2023-10-03T13:08:27.196Z","dependency_job_id":"c3843b79-3fc3-4f6d-a910-3bdccb5ed93b","html_url":"https://github.com/hynek/doc2dash","commit_stats":{"total_commits":585,"total_committers":20,"mean_commits":29.25,"dds":"0.14871794871794874","last_synced_commit":"36aad44325f0b9e555385acb36b8b4931c9cf936"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hynek%2Fdoc2dash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hynek%2Fdoc2dash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hynek%2Fdoc2dash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hynek%2Fdoc2dash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hynek","download_url":"https://codeload.github.com/hynek/doc2dash/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254384988,"owners_count":22062422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["converter","documentation","documentation-tool","mkdocs","mkdocstrings","pydoctor","python","sphinx"],"created_at":"2024-07-31T17:01:12.218Z","updated_at":"2025-05-15T17:05:28.949Z","avatar_url":"https://github.com/hynek.png","language":"Python","readme":"# Create Docsets for Dash and Friends\n\n[![Documentation](https://img.shields.io/badge/Docs-Read%20The%20Docs-black)](https://doc2dash.hynek.me/)\n[![License: MIT](https://img.shields.io/badge/license-MIT-C06524)](https://github.com/hynek/doc2dash/blob/main/LICENSE)\n[![Homebrew Tap](https://img.shields.io/badge/Homebrew-tap-brown)](https://github.com/hynek/homebrew-tap)\n[![Current PyPI release](https://img.shields.io/pypi/v/doc2dash)](https://pypi.org/project/doc2dash/)\n\n\u003c!-- begin-short --\u003e\n\n*doc2dash* is an extensible [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) (*docset*) generator that helps you to have documentation for all your favorite APIs in [Dash-compatible](https://kapeli.com/dash/) API browsers.\n\nAn API browser is an application that runs locally on your computer and allows you to search various API docs by pressing a key combination and starting to type (I have bound it to ⌥Space bar and can’t write code without it).\n\nThe most common ones – [Dash](https://kapeli.com/dash) (macOS) and [Zeal](https://zealdocs.org) (Windows and Linux) – come with **many** docsets out of the box, but they can never offer you docsets for *every* package you’ll ever use.\nThis is where *doc2dash* comes in:\nIt takes your offline documentation and converts it into an indexed format that API browsers can read and search (very fast!).\n\nCurrently it supports all known *intersphinx*-based documentation systems like [Sphinx](https://www.sphinx-doc.org/), [*pydoctor*](https://github.com/twisted/pydoctor), or [MkDocs](https://www.mkdocs.org) (with [*mkdocstrings*](https://mkdocstrings.github.io)).\nWhile *doc2dash* is a Python project, the support is **not** limited to Python-related formats.\n\nIt’s also extendable: [**you** can write your own parser](https://doc2dash.hynek.me/en/latest/extending/)!\n\n![doc2dash Session](docs/doc2dash-session.gif)\n\n\n## Quickstart\n\nThe fastest way to get started is installing *doc2dash* from our [Homebrew tap](https://github.com/hynek/homebrew-tap):\n\n```console\n$ brew install hynek/tap/doc2dash\n```\n\n\u003e [!NOTE]\n\u003e If you can’t – or won’t – use [Homebrew](https://brew.sh), check out our [installation instructions](https://doc2dash.hynek.me/en/latest/installation/) for alternatives.\n\nThen point *doc2dash* at a directory containing **built** [*intersphinx*-compatible](https://doc2dash.hynek.me/en/stable/formats/) documentation:\n\n```console\n$ doc2dash directory/to/documentation\n```\n\nYou should see an output like in the video above and find an appropriately named *docset* in the current directory.\nThat’s it – you can add it to Dash or Zeal!\n\n---\n\n*doc2dash* has many more features and options – make sure to check out the [usage](https://doc2dash.hynek.me/en/stable/usage/) for more details.\nA full how-to is [available too](https://doc2dash.hynek.me/en/latest/how-to/).\n\n\n## Project Links\n\n- [**Homebrew Tap**](https://github.com/hynek/homebrew-tap)\n- [**Pre-compiled Binaries**](https://github.com/hynek/doc2dash/releases)\n- [**PyPI**](https://pypi.org/project/doc2dash/)\n- [**Changelog**](https://github.com/hynek/doc2dash/blob/main/CHANGELOG.md)\n- [**Documentation**](https://doc2dash.hynek.me/)\n- [**Funding**](https://hynek.me/say-thanks/)\n\n\n## Credits\n\n*doc2dash* is maintained by Hynek Schlawack and released under the [MIT](https://github.com/hynek/doc2dash/blob/main/LICENSE) license.\n\nThe development is kindly supported by my employer [Variomedia AG](https://www.variomedia.de/) and all my amazing [GitHub Sponsors](https://github.com/sponsors/hynek).\n","funding_links":["https://github.com/sponsors/hynek"],"categories":["\u003ca id=\"tag-dev\" href=\"#tag-dev\"\u003eDev\u003c/a\u003e","Python"],"sub_categories":["\u003ca id=\"tag-dev.docs\" href=\"#tag-dev.docs\"\u003eDocs\u003c/a\u003e"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhynek%2Fdoc2dash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhynek%2Fdoc2dash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhynek%2Fdoc2dash/lists"}