Fix doxygen on ReadTheDocs (+ return to srun for MPI tests on tioga) #1016
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bmhan12
added
CI
bmhan12
force-pushed
the
test/han12/doxyTree
branch
from
a5d65cb
to
65d0b7c
Compare
bmhan12
commented
Jan 31, 2023
| # Modify Doxyfile for ReadTheDocs compatibility | ||
| with open('./docs/doxygen/Doxyfile.in', 'r') as f: | ||
| fdata = f.read() | ||
| fdata = fdata.replace('@PROJECT_SOURCE_DIR@', '.') | ||
| with open('./docs/doxygen/Doxyfile.in', 'w') as f: | ||
| f.write(fdata) | ||
| with open('./docs/doxygen/Doxyfile.in', 'a') as f: | ||
| f.write("\nOUTPUT_DIRECTORY=./_build/html/doxygen") | ||
| f.write("\nOUTPUT_DIRECTORY=../_readthedocs/html/doxygen") |
There was a problem hiding this comment.
This PR by ReadtheDocs introduced the change, and will likely impact most github projects using doxygen on ReadTheDocs:
readthedocs/readthedocs.org#9888
Doxygen generation broken in latest RAJA:
https://raja.readthedocs.io/en/develop/doxygen/html/index.html
The breaking change in their PR was renaming the hosted output directory from ./_build/html/... to ./_readthedocs/html/...
Seems like alot of projects are dependent on this _build directory:
https://github.com/search?q=filename%3Aconf.py+doxygen+%26%26+_build&type=Code
There was a problem hiding this comment.
@bmhan12 Thanks for pointing this out.
rhornung67
approved these changes
Jan 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR:
sruncallsflux mini rununderneath. Issue last week was flux wrappers not being initialized by default on the system after updates.