Building Documentation

The source files for the documentation can be found in the directory docs. The documentation is built using Material for MKDocs. To install it please run the following commands,

pip install mkdocs
pip install mkdocs-material

To work on the documentation locally, it can be served using

mkdocs serve

from the xdiag root source directory. A local build of the documentation can then be accessed in a webbrowser at the adress

127.0.0.1:8000