To test documentation changes locally, you'll need to install mkdocs
and the relevant dependencies in your Python environment.
We've included a server launching script for ease of use.
- Create a virtual environment for your installation.
python -m venv venv-ilab-docs
source venv-ilab-docs/bin/activate
- Launch the server.
This will:
- Install mkdocs
- Install the PyPI dependencies
- Launch the mkdocs server locally
./launch_server.sh
- Visit https://127.0.0.1:8000/ to see your changes in the browser.