i-PI documentation

This folder contains the files needed to locally build the documentation for i-PI.

• latex/ contains the "legacy" TeX manual, that includes also autogenerated input reference
• scripts/ contains automatic scripts to build the input reference
• src/ contains RST files that are compiled by sphynx into the HTML documentation.

To build the docs locally, install tox (pip install tox) and run tox -e docs from the repository root. The HTML output will be generated in docs/_build/html.

The PDF manual (ipi-manual.pdf, shipped alongside the HTML on the public docs site) is built by CI and does not need to be built locally. If you do want to reproduce it, install a LaTeX toolchain first (sudo apt install texlive-latex-extra texlive-lang-greek latexmk) and run tox -e docs-pdf, from the repository root. The document will be generated in docs/_build/latex.

The input documentation is automatically generated based on the helpstrings in the input folder. When you add a new tag, you should also add an entry into scripts/help.py to have it added to the documentation.

Further details on how to setup the TeX build can be obtained follow the instructions in latex/, where you can also generate the PDF without running through tox.