-
Notifications
You must be signed in to change notification settings - Fork 37
DOC: migrate documents to readthedocs #1033
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
carns
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is great! I'll leave it to you @wkliao to determine how to coordinate the timing (I don't know if we should merge this, add some tags in the format rtd expects, or update the web site)
|
Because there is no new commits pushed to the main branch between 3.4.7 and this PR, we can simply merge this PR now. If you would like to make a public announcement for the readthedocs migration soon, we can create a new tag now using the readthedocs required version format, e.g. 3.4.7.1, or v3.4.7.1. Such that readthedocs can identify it as a stable version. Public announcement can be done in 2 places: GitHub repo README.md and Darshan web home page. The former can be done by a new PR. If these sound fine with you, I will go ahead merge this PR. |
|
Sounds good, with the only suggested tweak being that we update the links on the Darshan web site to refer to readthedocs before we announce the migration. Post-migration we need to:
|
|
(so please do go ahead and merge and make tags whenever you are ready @wkliao ) |
|
I pushed another commit about Updating URLs on CELS will be separated from this PR. |
|
A new tag, 3.4.7.1, has been created, which triggered readthedocs to recognize it as the latest stable release. |
Readthedocs has a nice integration with Github CI. A commit pushed to a branch
of Darshan's repo can trigger a rebuild of all Darshan's documents, which include
A short developer guide is provided in file ./readthedocs/DEVELOPER_NOTES.md