For developers who want to contribute to the website/documentation of libigl. If you want to preview changes to the libigl website before a commit, you can follow the instructions below.
- Install mkdocs and the material theme
pip3 install -U --user mkdocs mkdocs-material
- Preview the website locally (in the root folder of the libigl project):
python3 -m mkdocs serve
- Build the website to generate the html locally (optional):
python3 -m mkdocs build
- Deploy the website directly to github (will overwrite the gh-pages branch of the remote repository):
python3 -m mkdocs gh-deploy
!!! warning
The gh-deploy script will overwrite the content of the gh-pages in the remote repository. Be sure of what you are doing before pushing new content with this command.
!!! tip
Be careful to not have any <> characters in your email in your .gitconfig, otherwise the gh-deploy script will fail.
!!! tip
Dead links can be checked using the LinkChecker tool. Run the website locally, then run LinkChecker on it:
bash linkchecker http://127.0.0.1:8000
!!! note
The reason we are using python -m mkdocs serve instead of mkdocs serve directly is because we are using local extensions for mkdocs. Those extensions are located in the scripts/ folder of libigl. Running mkdocs as a module adds the current directory to the PYTHONPATH, allowing us to load those extensions without installing them on the system or in a virtualenv.
- Use virtualenv to run a specific version of mkdocs/mkdocs-material, to avoid incompatible changes from breaking the build...