From cc3649de41d133307799000339243b6d7dfe09ea Mon Sep 17 00:00:00 2001 From: Ole Schuett Date: Thu, 10 Aug 2023 14:59:29 +0200 Subject: [PATCH] Docs: Add README --- docs/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..d598a61377 --- /dev/null +++ b/docs/README.md @@ -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`