You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEVELOPER_NOTES.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,14 @@
2
2
---
3
3
4
4
### Note on configuring Read the Docs tool for user guide generation
5
+
* Read the Docs settings
6
+
* User guide is automatically generated on main branch changes and opened PR requests. Modify this in Read the Docs dashboard if needed
5
7
* Doc files
6
8
*`.readthedocs.yaml` -- The script that controls commands that run before installation of pnetcdf-python (under `pre-install:`) and installation (under `python:`)
7
9
*`/docs/requirements.txt` -- Python dependencies required for doc generation, including `sphinx`
8
10
* Important environment variables
9
-
* User guide generation requires enviroment variables set by Read the Docs dashboard (`Admin` -> `Environment Variables`). Delete and add a new variable to modify
10
-
* Current environment variables set:
11
+
* User guide generation requires enviroment variables set by Read the Docs dashboard (`Admin` -> `Environment Variables`). Delete and add a new variable to modify (remember to select `Expose this environment variable in PR builds` if PR auto-build is enabled)
12
+
* Current environment variables set (only effective solution found to set env variable at installation):
0 commit comments