Skip to content
Laura Wrubel edited this page Apr 6, 2021 · 3 revisions

Hosting at readthedocs.io:

SFM documentation lives at sfm.readthedocs.io. To review and trigger builds manually, go to readthedocs.io and log in. The sfm project is the current documentation.

Setting up docs on your VM:

  1. Install requirements in your virtualenv:

pip install sphinx sphinx-autobuild sphinx-rtd-theme

  1. Build the docs and run on a specific port:

sphinx-autobuild docs docs/_build/html --host 0.0.0.0 --port 8888

Note that the port must be open in the WRLC firewall for your dev VM.

Building and running locally:

  1. Install requirements as above.
  2. Build the docs:

sphinx-autobuild docs docs/_build/html