Building the Documentation¶
Building the documentation locally can help you visualize change you are making to the docs. What you see locally should be what you see online.
Documentation is built using MkDocs. You will need to latest version of Python (tested on version 3.7.1) and pip. If you're on the Windows operating system, make sure you have added Python to your Path environment variable.
When executing the pip module on Windows you can prefix it with python -m. For example:
python -m pip install mkdocs-material
- Install MkDocs
pip install mkdocs==1.2.2
pip install markdown-include
- Install the Material theme
pip install mkdocs-material==7.2.4
- Serve it up
- Open a browser to http://127.0.0.1:8000/
mkdocs gh-deployfrom main branch