Doc2dash

Highlights

This release adds support for high-resolution icons, docset playgrounds URLs, and control over full-text search.

Special Thanks

This release would not be possible without my generous sponsors! Thank you to all of you making sustainable maintenance possible! If *you* would like to join them, go to <https://github.com/sponsors/hynek> and check out the sweet perks!


Above and Beyond

[Variomedia AG](https://www.variomedia.de/) ([variomedia](https://github.com/variomedia)), [Tidelift](https://www.tidelift.com/) ([tidelift](https://github.com/tidelift)), [FilePreviews](http://filepreviews.io/) ([filepreviews](https://github.com/filepreviews)), Daniel Fortunov ([asqui](https://github.com/asqui)), Kevin P. Fleming ([kpfleming](https://github.com/kpfleming)), and [Sören Weber](https://www.gedankenspieler.org/) ([SoerenWeber](https://github.com/SoerenWeber)).


Maintenance Sustainers

[Jeff Triplett](https://webology.dev) ([jefftriplett](https://github.com/jefftriplett)), [Adam Hill](https://adamghill.com) ([adamghill](https://github.com/adamghill)), Dan Groshev ([si14](https://github.com/si14)), Magnus Watn ([magnuswatn](https://github.com/magnuswatn)), [David Cramer](http://cra.mr) ([dcramer](https://github.com/dcramer)), Moving Content AG ([moving-content](https://github.com/moving-content)), [ProteinQure](https://proteinqure.com/) ([ProteinQure](https://github.com/ProteinQure)), Jesse Snyder ([jessesnyder](https://github.com/jessesnyder)), [Rivo Laks](https://rivolaks.com) ([rivol](https://github.com/rivol)), [Ionel Cristian Mărieș](https://blog.ionelmc.ro) ([ionelmc](https://github.com/ionelmc)), [The Westervelt Company](https://westervelt.com) ([westerveltco](https://github.com/westerveltco)), Philippe Galvan ([PhilippeGalvan](https://github.com/PhilippeGalvan)), [Birk Jernström](https://polar.sh) ([birkjernstrom](https://github.com/birkjernstrom)), [Tim Schilling](https://www.better-simple.com) ([tim-schilling](https://github.com/tim-schilling)), Chris Withers ([cjw296](https://github.com/cjw296)), [Christopher Dignam](https://christopher.xyz) ([chdsbd](https://github.com/chdsbd)), [Stefan Hagen](https://stefan-hagen.website) ([sthagen](https://github.com/sthagen)), [Sławomir Ehlert](https://slafs.net) ([slafs](https://github.com/slafs)), Mostafa Khalil ([khadrawy](https://github.com/khadrawy)), [Filip Mularczyk](https://fmularczyk.pl) ([mukiblejlok](https://github.com/mukiblejlok)), [Mike Fiedler](https://mike.fiedler.me) ([miketheman](https://github.com/miketheman)), and [Michel Vittória](https://www.linkedin.com/in/michelvittoria/) ([michelvittoria](https://github.com/michelvittoria)).

Not to forget 5 more amazing humans who chose to be generous but anonymous!


Full Changelog

Added

- Support for high resolution icons using the `--icon-2x` option. [\200](https://github.com/hynek/doc2dash/pull/200)

- Support for linking to [docset playgrounds](https://kapeli.com/docsets#docsetPlaygrounds) using the `--playground-url` option. [\201](https://github.com/hynek/doc2dash/pull/201)

- Control over [full-text search](https://kapeli.com/docsets#fts) using the `--full-text-search=(on|off|forbidden)` option. [\202](https://github.com/hynek/doc2dash/pull/202)

Fixed

- The table of contents-generation for *pydoctor*-based documentation has been restored. [\133](https://github.com/hynek/doc2dash/pull/133)

Presenting the biggest _doc2dash_ release ever!

Most importantly, as you can see below, there's stand-alone binaries for Linux, macOS, and Windows for amd64 platforms! No more Python (if you don't want to)! I found this so exciting, [I wrote a short Today-I-Learned post about it](https://hynek.me/til/python-portable-binaries/). But even if you keep using it via Python, the dependency tree got a lot slimmer since it doesn't depend on Sphinx anymore.

Feature-wise this release introduces first-class support for _MkDocs_ and improves its _pydoctor_ support while at it.

There's a lot more that happened, including prettier (and more informative) progress bars and smarter handling of imperfect indixes.

All-in-all, it comes close to a complete rewrite. I hope you enjoy it, and if you haven't played with [_Dash.app_](https://kapeli.com/dash) or [_Zeal_](https://zealdocs.org) until now – now is the perfect moment!

P.S. Sorry, I also broke your custom plugins. But there's [docs](https://doc2dash.readthedocs.io/en/stable/extending/) on writing your own now!


Full Changelog

Removed

- Since *pydoctor* added support for *intersphinx* in version 21.2.0, the dedicated HTML-parsing parser has been removed. If you need to parse legacy *pydoctor* docs, please use *doc2dash* 2.4.1.


Added

- Stand-alone binaries! If your platform is supported, you can now download binaries from the release page without dealing with Python at all – courtesy of [*PyOxidizer*](https://pyoxidizer.readthedocs.io/).
- *intersphinx*: documentation based on [*MkDocs*](https://www.mkdocs.org/) with [*mkdocstrings*](https://mkdocstrings.github.io/) metadata is now supported.
- *intersphinx*: if no explicit name is passed, the docset name is derived von the documentation's metadata (and not the directory name, which is more often than not just `html`).
- We use [*rich*](https://rich.readthedocs.io/) for output and progress bars now. This allows us more granular progress indication.
- Documentation on writing your own parser plugins.


Changed

- Tons of refactorings that probably broke your custom parsers. Sorry about that and let us know, if we can help you fixing them.
- *intersphinx*: We now parse `objects.inv` files on our own. *Sphinx* is not a dependency anymore.
- *intersphinx*: Files that are indexed by *intersphinx*, but don't exist aren't added to the docset anymore. Common example is `py-modindex.html`. [113](https://github.com/hynek/doc2dash/issues/113) [#115](https://github.com/hynek/doc2dash/issues/115)
- We now check if the index page passed via `--index-page` / `-I` exists and fail if it doesn't.

- Added support for URL-encoded filenames. [104](https://github.com/hynek/doc2dash/pull/104)

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](https://github.com/hynek/doc2dash/pull/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`.

- `InterSphinxParser` is now open to extension. [\59](https://github.com/hynek/doc2dash/pull/59)
- Support a `--parser` option to force the use of a custom parser
class. [\60](https://github.com/hynek/doc2dash/pull/60)

<ul class="simple">
<li>Remove legacy Sphinx parsing.
The intersphinx parser is much more robust so the old way shouldn&8217;t be needed anymore.</li>
<li>Add support for InterSphinx constants.
<a class="reference external" href="https://github.com/hynek/doc2dash/pull/49">#49</a></li>
<li>Fix handling in-docs links with multiple anchors.
<a class="reference external" href="https://github.com/hynek/doc2dash/issues/47">#47</a></li>
<li>Add support for <code class="docutils literal"><span class="pre">--enable-js</span></code> and <code class="docutils literal"><span class="pre">--online-redirect-url</span></code> options.
<a class="reference external" href="https://github.com/hynek/doc2dash/issues/43">#43</a></li>
<li>Better support for relative paths.
<a class="reference external" href="https://github.com/hynek/doc2dash/issues/37">#37</a>, <a class="reference external" href="https://github.com/hynek/doc2dash/issues/41">#41</a></li>
</ul>