-
Notifications
You must be signed in to change notification settings - Fork 25
Readthedocs set up
Laura Wrubel edited this page Apr 6, 2021
·
3 revisions
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.
- Install requirements in your virtualenv:
pip install sphinx sphinx-autobuild sphinx-rtd-theme
- 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.
- Install requirements as above.
- Build the docs:
sphinx-autobuild docs docs/_build/html