@@ -337,21 +337,25 @@ Note on configuring Read-the-Docs tool for generating PnetCDF-Python user guide.
337337 + User guide is automatically generated when new commits are pushed to the
338338 main branch and a new PR is created. Modify this in Read the Docs dashboard
339339 if needed.
340+ + https://app.readthedocs.org/dashboard/
341+ + A new maintainer can sign up with readthedocs using his/her github account
342+ + Under the project's Settings -> maintainers, a maintainer can invite others
343+ to become a maintain.
340344
341- * Doc files
342- + ` .readthedocs.yaml` -- is a script file controls commands that run before
343- installation of PnetCDF-Python (under `pre-install:`) and installation
344- (under `python:`)
345- + `/ docs/requirements.txt` -- lists all Python dependencies required for doc
346- generation, including `sphinx`
345+ * Configuration files
346+ + [ .readthedocs.yaml](../.readthedocs.yaml) -- is a script file controls
347+ commands that run before installation of PnetCDF-Python (under
348+ `pre-install:`) and installation (under `python:`)
349+ + [ docs/requirements.txt](./requirements.txt) -- is a file containing a list
350+ all Python dependencies required for doc generation, including `sphinx`.
347351
348352* Important environment variables
349353 + User guide generation requires environment variables set by Read the Docs
350- dashboard (`Admin ` -> `Environment Variables`). Delete and add a new
354+ dashboard (`Settings ` -> `Environment Variables`). Delete and add a new
351355 variable to modify (remember to select `Expose this environment variable in
352356 PR builds` if PR auto-build is enabled)
353- + Current environment variables set (only effective solution found to set env
354- variable at installation):
357+ + Current environment variables set (the only effective solution found to set
358+ the environment variable at installation):
355359 * `CC`: mpicc.mpich
356360 * `PNETCDF_DIR`: /home/docs/checkouts/readthedocs.org/user_builds/pnetcdf-python/checkouts/latest/_readthedocs/PnetCDF
357361 * `PNETCDF_VER`: 1.14.0
0 commit comments