These are the source of the CP2K manual. They are published daily by this script.

To build a local version of the manual perform the following steps:

1. Create and activate a virtual Python environment:

   python3 -m venv ../docs_venv source ../docs_venv/bin/activate

2. Install the required Python packages:

   pip3 install -r ./requirements.txt

3. (optional) Build a CP2K binary and use it to generate the cp2k_input.xml file:

   ../exe/local/cp2k.psmp --xml

4. (optional) Generate Markdown pages from the cp2k_input.xml file:

   ./generate_input_reference.py ./cp2k_input.xml

5. Run Sphinx:

   make html

6. Browse the HTML output in the _build/html directory.

The CP2K manual uses Sphinx with the MyST parser for Markdown support. The following gives a quick overview of the syntax:

For a all typography options see the MyST documentation.

• Acronym: {term}`ADMM`
• Publication: [](#Wilhelm2018)
• Other page: [](../properties/optical/tddft)
• Input section: [FORCE_EVAL](#CP2K_INPUT.FORCE_EVAL)
• Input keyword: [STRESS_TENSOR](#CP2K_INPUT.FORCE_EVAL.STRESS_TENSOR)
• External URL: <https://www.gromacs.org>
• External URL with label: [click here](https://github.com/cp2k/cp2k-examples/blob/master/qm_mm/Protein.pdb)

For a all table options see the MyST documentation.

See also the MyST and MathJax documentation.

For all available admonitions see the MyST documentation.

For details see the Mermaid documentation and also check out their great live editor.

The above example links to https://www.youtube.com/watch?v=teHVWKwBOTU at the 1500 seconds time mark.