Add README in the docs folder for adding new sites

gselzer · gselzer · commit 413e649a6fb8 · 2023-12-11T13:57:39.000-06:00
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,21 @@
+# Adding a new ReadTheDocs page for a project in this repository
+
+We use [`sphinx-multiproject`](https://sphinx-multiproject.readthedocs.io/en/latest/index.html) to build multiple RTD sites from within a single repository. To add a new site within this repository, take the following steps:
+
+## Create a new subfolder for the site's documents
+
+See the existing `ops` folder for a template.
+
+## Add relevant sections to this folder's `conf.py`
+
+Specifically, you'll want to add an entry to the `multiproject_projects` dictionary. Again, you can copy and edit the `ops` entry.
+
+## Create a new project on `ReadTheDocs`
+
+You'll want to take the following steps:
+1. Choose to import a project manually
+2. Set the repository URL to the GitHub of this project
+3. In the `Admin` section of the newly created site, find the `Advanced Settings` tab and change the `Path for .readthedocs.yaml` to `docs/.readthedocs.yaml`
+4. In the `Admin` section of the newly created site, find the `Environment Variables` tab and add a new variable, mapping the `PROJECT` environment variable to the newly added key in the `multiproject_projects` dictionary.
+
+After that, you should have a new site ready to go!
