This is the documentation repository of the PSLab project.

The theme implements Material UI.

The documentation is built with MkDocs using the Material for MkDocs theme.

The configuration is in mkdocs.yml located in the root of the repository.

Using a Python virtual environment allows you to install the prerequisites in a sandbox without conflicting with system libraries.

python -m venv .venv
source .venv/bin/activate  # On Windows use: .venv\Scripts\activate

pip install -r requirements.txt

You can start a local development server with live-reloading:

mkdocs serve

The output will be available at http://127.0.0.1:8000/.

If you want to generate the static HTML files:

mkdocs build

The output will be in the site/ directory.

Check the markdown guide to get familiar with the syntax. For more details on contributing to PSLab documentation, see the Collaboration Guide.

Every pull request is checked to ensure the documentation builds successfully. When merged to the main branch, the docs are deployed automatically to GitHub Pages via GitHub Actions.