v5.0.x: Yet more docs updates #10255
Merged
Conversation
This file contains hidden or 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
This was referenced Apr 11, 2022
Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit c138f42)
Be foreward looking and use the "new" dependency resolver. This also fixes a dependency issue with docutils in some environments (e.g., Fedora 33). Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit 638b495)
citutor.org is now hpc-training.org. Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit faa0881)
HTML docs are installed in $(docdir)/html. Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit 8ffe33f)
Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit ff9b031)
Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit df9178d)
jsquyres
force-pushed
the
pr/v5.0.x/yet-more-docs-updates
branch
from
62f6a1b to
48f57e6
Compare
|
Still want to add the contents of #10258 to this PR before marking it ready for review. EDIT: Done! |
Follow-on to 8ffe33f: do not set the dirs in the installed HTML files tree to have 0755 permissions because Automake doesn't do that when it creates directories. Instead, use "find ..." to find all directories and files in the generated _built/html tree and use the Automake-provided installer macros to create the target directories and install the target files with desireable permissions. Additionally, add a comment explaining why the install-data-hook rule exists, and why we are doing what we are doing in it. Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit 1867a72)
|
This PR is now ready for v5.0.x. |
awlauria
approved these changes
Apr 13, 2022
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 is the v5.0.x PR of #10213.
The biggest change is that the HTML docs are now also installed.
Marked as draft because I made a change after Brian's review that I thought would not be controversial, but Brian had some additional comments about it. It will take an additional commit (to be cherry-picked here) to address.