Skip to content

Commit edcab18

Browse files
author
Phil Carns
committed
note how to preview documentation updates
1 parent e7deabe commit edcab18

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

readthedocs/DEVELOPER_NOTES.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,19 @@
6363
+ darshan-util/pydarshan/docs/usage
6464
+ darshan-util/pydarshan/docs/api/pydarshan/modules
6565

66+
### Previewing updates
6667

67-
68+
Use the following steps to review documentation changes before they are
69+
merged to the main branch:
70+
* Modify the appropriate files (see `index.rst` and the list of included
71+
documents described in the preceding subsection)
72+
* Open a pull request on GitHub with your changes
73+
* Wait a few minutes for automated actions to occurr on ReadTheDocs
74+
* Log into https://app.readthedocs.org
75+
* Navigate to the Darshan dashboard and click the `Builds` tab
76+
* Select the corresponding pull request and click the `View Docs` button
77+
* Validate the changes, push additional commits if needed, and merge the PR
78+
when ready
79+
* Wait a few minutes for ReadTheDocs automation
80+
* Confirm that the updates are visible at https://darshan.readthedocs.io/en/latest/
6881

0 commit comments

Comments
 (0)