comp-chem/cp2k
1
0
Fork 0
mirror of https://github.com/cp2k/cp2k.git synced 2026-07-29 06:35:28 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Add README

Browse source
This commit is contained in:
Ole Schuett 2023-08-10 14:59:29 +02:00 • committed by Ole Schütt
parent d1376dc496
commit cc3649de41
1 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/README.md Normal file
View file

@ -0,0 +1,21 @@
# CP2K Documentation
These are the source of the [CP2K manual](https://manual.cp2k.org/trunk). They are published daily by [this script](../tools/docker/scripts/test_manual.sh).
To build a local version of the manual perform the following steps:
1. Install the required Python packaged:
`pip3 install sphinx myst-parser sphinx_rtd_theme lxml`
1. Build a CP2K binary and generate `cp2k_input.xml` file:
`cp2k/exe/local/cp2k.psmp --xml`
1. Generate the Markdown files from the XML file:
`cp2k/docs/generate_input_reference.py ./cp2k_input.xml ./references.html`
1. And finally run Sphinx:
`sphinx-build cp2k/docs/ output_dir -W -n --keep-going --jobs 16`