chazeon / qe-docset

Dash docset generator for Quantum ESPRESSO.

QE Docset

The scripts in this repo is designated to generated a docset for Quantum ESPRESSO (QE), an open-source package for electronic-structure calculations and materials modeling at the nanoscale, which should work with offline API documentation browsers such as Dash and Zeal.

How to scrape and build docset

First, install the required dependencies

python3 -m pip install -r requirements.txt

then run the scripts

mkdir -p qe.docset/Contents/Resources/Documents
python3 scripts/scrape.py
python3 scripts/docs2set.py
python3 scripts/toc4docs.py

Prebuilt docset

• Avaliable as GitHub Action Artifact (or via direct link).

Acknowledgement

Docset icons, icon.png and [e-mail], are derived from QE's official logo.