Overview

This explains how to generate the documentation for ImpactX, and contribute to it.

Generating the documentation

Installing the requirements

Install the Python requirements for compiling the documentation:

pip install sphinx sphinx_rtd_theme

Compiling the documentation

cd into this directory and type

make html

You can then open the file build/html/index.html with a standard web browser (e.g. Firefox), in order to visualize the results on your local computer.

Cleaning the documentation

In order to remove all of the generated files, use:

make clean