{"repo":"hynek/doc2dash","free":true,"listed":false,"github":"https://github.com/hynek/doc2dash","clone":"git clone https://github.com/hynek/doc2dash.git","description":"Create docsets for Dash.app-compatible API browsers.","language":"Python","stars":599,"topics":["documentation","documentation-tool","python","converter","sphinx","pydoctor","mkdocs","mkdocstrings"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Create Docsets for Dash and Friends doc2dash is an extensible Documentation Set ( docset ) generator that helps you to have documentation for all your favorite APIs in Dash-compatible API browsers. An 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). The most common ones – Dash (macOS) and Zeal (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. This is where doc2dash comes in: It takes your offline documentation and converts it into an indexed format that API browsers can read and search (very fast!). Currently it supports all known intersphinx -based documentation systems like Sphinx, pydoctor , or MkDocs (with mkdocstrings ). While doc2dash is a Python project, the support is not limited to Python-related formats. It’s also extendable: you can write your own parser! Quickstart The fastest way to get started is installing doc2dash from our Homebrew tap: [!NOTE] If you can’t – or won’t – use Homebrew, check out our installation instructions for alternatives. Then point doc2dash at a directory containing built intersphinx -compatible documentation: You should see an output like in the video above and find an appropriately named docset in the current directory. That’s it – you can add it to Dash or Zeal! --- doc2dash has many m","default_branch":null,"files":null,"tree":[],"storefront":"/r/hynek","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/hynek/doc2dash/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}