Building the Documentation

As long as you have followed the procedure in Polaris pixi and spack environments, compilers and system modules for setting up your local Polaris deployment environment (pixi-based), you will already have the packages available that you need to build the documentation.

Then, run the following script to build the docs:

cd docs
DOCS_VERSION=test make clean versioned-html

The docs must build cleanly without errors or warnings. Otherwise, CI will not pass on the PR bringing in the changes.

Previewing the Documentation

To preview the documentation locally, open the index.html file in the _build/html/test directory with your browser or try:

  cd _build/html
  python -m http.server 8000

Then, open http://0.0.0.0:8000/test/ in your browser.