The documentation website can be accessed here.
This website is built using the Material for MkDocs theme.
MkDocs can be installed through pip with the following command:
pip install mkdocs
pip install mkdocs-material
mkdocs serve
Please refer to MkDocs' official Getting Started and User guides for detailed documentation.
Detailed customization options can be found at Material for MkDocs' official website.
Please make sure to git pull from the main branch before executing the following command:
mkdocs gh-deploy
This command automatically builds the website, copies the built files to the gh-pages branch, and pushes it. This should then be reflected in the project's documentation site after a few minutes. Therefore, please do not directly modify the files from the gh-pages branch as any manual changes to it will be overridden whenever the above command is executed.