Skip to content

Hosting Docs Locally⚓︎

When making changes to user APIs or other significant parts of the code, it's important to also update the relevant documentation.

PyPDFForm uses MkDocs to build its documentation. You can either host it locally in a virtual environment or run it in the development 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/.