DRAFT: Prep RTD deployment

.readthedocs.yaml

@@ -0,0 +1,41 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-latest
+  tools:
+    python: "3.11"
+
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+
+python:
+  install:
+    - requirements: docs/requirements.txt

README.md

@@ -115,6 +115,16 @@ $ descriptive-analytics demo-projects/ARChetypeCRF_dengue_synthetic/
 The `descriptive-analytics` tool requires Google Chrome to be installed as some Chrome imaging functionality is used by the [`kaleido`](https://plotly.com/python/static-image-export/#kaleido) dependency when exporting/saving
 images - see [this](https://plotly.com/python/static-image-export/) for further information.
 
+## Documentation
+
+VERTEX project documentation is built with [Sphinx](https://www.sphinx-doc.org/en/) from content and configuration defined in the [`docs`](https://github.com/ISARICResearch/VERTEX/tree/main/docs) subfolder. Deployment will be to [ReadTheDocs](https://readthedocs.org) on a custom ISARIC domain, and is the process of being implemented.
+
+The documentation can be built locally by running:
+```shell
+make -C docs html
+```
+from the project root and then using a browser to open the `index.html` page in `docs/_build`. Changes to content can be made in the `docs/.rst` or `docs/sources/*.rst` files, and changes in configuration can be made in the `docs/conf.py` file. Any changes should be staged and version controlled in the normal way as with changes to code.
+
 ## Contributors
 
 - Esteban Garcia-Gallo - [esteban.garcia@ndm.ox.ac.uk](mailto:esteban.garcia@ndm.ox.ac.uk)