Bash script and guide to generate offline docs for Zeal

[hudmont]

I'm a big fan of having offline docs on my machines, and I use Zeal for this purpose (among other things). Of course one could also just browse the sphinx-generated html pages, I just prefer this interface.

Zeal uses Dash.app's documentation format, which can be converted from sphinx-generated docs ( Hy has such docs ). It is quite easy to do this by hand, but I made myself a bash script (didn't test, but probably POSIX-compatible) which helps me remember the process, and I'm sharing it in the hope that others will also get some use out of it.

The relevant stuff needed to build the sphinx docs is up on the "hacking on hy" section of the Hy documentation, and the tool needed for the conversion is doc2dash, which is easily installable by pip or pipx.

#!/usr/bin/env bash
# we need to be in the hy/docs directory
# taken from the relevant section from "hacking on hy" 
sphinx-build -b html .  _build

# deleting the current docs, if they exist 
# we probably need to stop Zeal before this, if it runs
if [ -d "$HOME/.local/share/Zeal/Zeal/docsets/Hy.docset" ]
then
    rm -rf "$HOME/.local/share/Zeal/Zeal/docsets/Hy.docset"
fi

doc2dash -n Hy -d "$HOME/.local/share/Zeal/Zeal/docsets/" -i _static/hy_logo.png -I index.html _build```