Local Preview¶

Use these commands when editing or reviewing the documentation site locally.

Start the Site¶

From the repository root:

cd hs-robotic-manipulation-course
source .docs-venv/bin/activate
mkdocs serve

Then open:

http://127.0.0.1:8000/

The terminal running mkdocs serve is the server process. Leave that terminal open while previewing.

If mkdocs serve is running in the foreground, press:

Control-C

To see the MkDocs process and PID:

ps -axo pid,ppid,stat,command | grep '[m]kdocs serve'

To see which process is listening on port 8000:

lsof -iTCP:8000 -sTCP:LISTEN -n -P

If the site is running in another terminal or the port is stuck, find the PID and stop it:

kill PID

Replace PID with the number from ps or lsof.

If it does not stop after a few seconds:

kill -9 PID

Prefer Control-C or kill PID first. Use kill -9 only for a stuck process.

To check the site without launching a local server:

source .docs-venv/bin/activate
mkdocs build --strict