Hosting Docs Locally

For guidance on when to update the User Guide and how to word changes, see the pull request requirements.

PyPDFForm uses MkDocs to build its documentation. You can either host it locally in a virtual environment or run it in the development container.

Virtual EnvironmentDevelopment Container

To host the documentation locally, run:

mkdocs serve -a 0.0.0.0:8080

Alternatively, to run the documentation in the development container:

docs

The documentation will be available at http://localhost:8080/.