pjmtdw/dash-docset-coq

Script to make Dash docset of Coq

What is this?

Coq Proof Assistant docset for Dash and their clones (e.g. Zeal).

The artifacts are uploaded to User Contributions of Dash.

Prerequiremens

• docker for building docset.

How to build

Run ./build.sh.

If you need to update pip package versions, you can add constraints in requirements.in and run ./pipcompile.sh to generate a new requirements.txt (though you will need python3 installed locally).

What is this doing?

As of Coq version 8.8.0, they migrated document tool from LaTeX to Sphinx. Therefore now we can use doc2dash which can generate Dash docset from Sphix document.

However, we need two tweaks for using this tool to gerenate Dash docset from Coq's document.

First, default Sphinx theme of Coq's document is sphinx_rdt_theme, which seems no option to disable sidebar. Hence we had to recompile the document with SPHINXOPTS="-Dhtml_theme=alabaster -Dhtml_theme_options.nosidebar=true"

Second, default sphinx parser of doc2dash only supports general directive type which differs from that of Coq. To solve the problem, we wrote small parser which supports directive type of Coq.