CCM Docs

This repository contains documentation for the Center for Computational Mathematics (CCM), built with MkDocs.

Setup (Conda)

conda env create -f mkdocs-env.yml
conda activate mkdocs

Rebuild the Conda mkdocs environment

Use this when dependencies drift or builds start failing unexpectedly.

conda deactivate
conda env remove -n mkdocs
conda env create -f mkdocs-env.yml

To refresh pinned docs dependencies and reinstall them into the mkdocs conda env:

python3 -m venv .venv-deps
source .venv-deps/bin/activate
python -m pip install --upgrade pip pip-tools
pip-compile --upgrade docs/requirements.in -o docs/requirements.txt
deactivate

conda run -n mkdocs python -m pip install -r docs/requirements.txt

Build the site (web server / Read the Docs style)

conda activate mkdocs
make build-web

This generates directory-style URLs in site/.

Build the site (local file:// browsing)

conda activate mkdocs
make build-file

This generates file-style URLs for opening site/index.html directly.

Run a local preview server

conda activate mkdocs
make serve

Then open in a browser: http://127.0.0.1:8000

View the built site in a browser

After make build-file, open site/index.html in your browser.

Examples:

• macOS:

  open site/index.html

• Linux:

  xdg-open site/index.html

• Windows PowerShell:

  start site\index.html

Alternative: pip/venv

python -m venv .venv
source .venv/bin/activate
pip install -r docs/requirements.txt
make build-web

On Windows PowerShell, activate with:

.venv\Scripts\Activate.ps1