The documentation for PM is generated using Hugo with the Docsy theme. The main advangtage of Hugo is how fast it is, and you can basically see your changes to the documentation in real time when viewing the site on a local server. The Docsy theme brings all of the advanced features that are needed for technical documentation, including detailed support for code markup (via prism), latex support (via katex), etc.
This documentation is stored in the github repository
principia-materia-docsy.
When you push to the github repository, the site will automatically be built using github actions and served at
https://marianettigroup.github.io/. If you want to push to github without rebuilding,
include [skip actions] in your commit message.
To view the documentation locally, start by installing hugo; snap is probably the most convenient way:
sudo snap install hugo
Now change into the directory of your local pm-docsy repo, and start the hugo server:
hugo server
You can then view the docs by pointing your browser to the local port that hugo prints out, which is normally http://localhost:1313/.
If you want to add to the documentation, you will find the markdown source files in the repo here: content/en/docs/.
If you want to modify the command line input tags, you will find the yaml file here: data/input_tag_info.yaml. An example entry in the yaml file is:
- name:
supa
description:
A matrix of integers \( \hat S_{BZ}\) that multiplies the lattice
vector matrix to yield the supercell lattice vectors, \(\hat S_{BZ}\hat a\).
type:
integer, matrix
dimension:
\(3\times3\)
scripts:
periodica, etc.
requires:
lattice_vectors