Skip to content

Commit 83b9b2b

Browse files
Jonathanlyjwkliao
authored andcommitted
modify DEVELOPER_NOTES.md to include user guide generation details
1 parent 3c4bd29 commit 83b9b2b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

DEVELOPER_NOTES.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
---
33

44
### 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
57
* Doc files
68
* `.readthedocs.yaml` -- The script that controls commands that run before installation of pnetcdf-python (under `pre-install:`) and installation (under `python:`)
79
* `/docs/requirements.txt` -- Python dependencies required for doc generation, including `sphinx`
810
* 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):
1113
* `CC`: mpicc.mpich
1214
* `PNETCDF_DIR`: /home/docs/checkouts/readthedocs.org/user_builds/pnetcdf-python/checkouts/latest/_readthedocs/PnetCDF
1315
* `PNETCDF_VER`: 1.12.3

0 commit comments

Comments
 (0)