Home

Documentation is built using Sphinx (https://www.sphinx-doc.org/) and is served through Read the Docs (https://readthedocs.org/). This is currently set up on my account (smithara) on Read the Docs (should open up admin to others)

Steps to change documentation:

1. Clone locally: git clone https://github.com/ESA-VirES/Swarm-VRE.git
2. Make changes to any files. Add the entry to index.rst if a new page is added
3. To check how it will look, compile it locally:
   1. Need to first have sphinx and the theme installed, e.g. conda install sphinx nbsphinx sphinx_rtd_theme

   2. cd docs
      make clean; make html; firefox _build/html/index.html &
      

4. Commit and push the changes. Check how they appear on https://swarm-vre.readthedocs.io