Running the Documentation Server Locally

Have you set up your local environment?

Make sure your local environment is set up by following the steps in the Setting Up the Local Environment guide.

By running the mkdocs documentation locally, you can create a dev server that updates itself as the documentation and code changes. This allows for better visualization of what the endstate will look like.

To run the mkdocs dev server, you simply have to run:

make mkdocs-dev

This will then serve the documentation at http://127.0.0.1:8000/.

If you make changes to any files in docs/ or pyticktick/, you should see the documentation refresh, it may just take a second to rebuild.