https://github.com/chazeon/qe-docset-autobuild
Autobuild script for QE-Docset.
https://github.com/chazeon/qe-docset-autobuild
api-documentation dash-docset documentation-tool quantum-chemistry quantum-espresso quantum-espresso-suite quantum-mechanics
Last synced: about 1 year ago
JSON representation
Autobuild script for QE-Docset.
- Host: GitHub
- URL: https://github.com/chazeon/qe-docset-autobuild
- Owner: chazeon
- Created: 2018-06-01T06:07:23.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-05T02:20:58.000Z (about 8 years ago)
- Last Synced: 2025-01-28T05:10:05.486Z (over 1 year ago)
- Topics: api-documentation, dash-docset, documentation-tool, quantum-chemistry, quantum-espresso, quantum-espresso-suite, quantum-mechanics
- Language: Python
- Homepage: https://chazeon.github.io/qe-docset/
- Size: 3.91 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# QE Docset Autobuild
The script that can easily build [QE Docset](https://github.com/chazeon/qe-docset) for multiple versions of Quantum ESPRESSO under one line of command.
# Usage
Clone the repo and the submodules, install Python submodule, and run
```
python3 check.py
```
and take a nap.
The script automatically pulls source code from Quantum ESPRESSO's official repo, and build the docsets.
Then you can run
```
python3 build_json.py
```
to build the required `docset.json` file that is required for submission.
# Performance
I don't expect the script being executed on a daily basis so the performance is not my prior concentration. However, based on my observation, `configure`ing and compiling documentation using `pdflatex` is the most time-consuming job. I have been running this job on my ThinkPad, it is equipped with an i5-7300U CPU, and the hard-drive is NVMe SSD drive. The test is perfomed on Linux Subsystem under Windows 10.
Under this setup, each take approximately 10-13 minutes, and total 13 jobs needs to be performed as of the day this README is authored, it is about 2 hours or so to finish the entire job.