Continued docs updates #10114
Merged
Continued docs updates #10114
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
|
While waiting for a review, I glommed on a few more commits with some more docs updates. 😄 |
jsquyres
changed the title
bwbarrett
reviewed
Mar 14, 2022
Minor updates to match the top-level index.rst verbiage on the v4.0.x and v4.1.x branches. Signed-off-by: Jeff Squyres <[email protected]>
jsquyres
force-pushed
the
pr/trivial-docs-updates
branch
5 times, most recently
from
caa7ddd to
6c852a2
Compare
|
The IBM CI (XL) build failed! Please review the log, linked below. Gist: https://gist.github.com/ibm-ompi/88b480fb98dfd2bdac939f023e1f8fe6 |
jsquyres
force-pushed
the
pr/trivial-docs-updates
branch
2 times, most recently
from
24f6876 to
fef8eb8
Compare
Having the Open MPI version at the top of the front index page is a good, obvious visual indicator to the user to which version these docs apply. Usually, the version we display is derived from the contents of the VERSION file. However, when releasing Open MPI, we typically go back and create an annotated git tag at a commit prior to the head of the release branch. This means that there is no git commit where the VERSION file has an empty "greek" version. As such, use the following scheme to determine what version string to use for the RST macro "|ompi_ver|": 1. If there is an environment variable named READTHEDOCS_VERSION, use that (this env variable is documented here: https://docs.readthedocs.io/en/stable/builds.html#build-environment) 2. Otherwise, use the contents of the Open MPI VERSION file Signed-off-by: Jeff Squyres <[email protected]>
Minor fixes and cleanups to the compilers-and-flags.rst page. Signed-off-by: Jeff Squyres <[email protected]>
"make linkcheck" showed a bunch of stale links; fix most of them. Also fix one RST minor error in the ULFM doc. Signed-off-by: Jeff Squyres <[email protected]>
This was just added in open-mpi#10119. Signed-off-by: Jeff Squyres <[email protected]>
Use the .readthedocs.yaml file to make ReadTheDocs fail the build if there are Sphinx warnings. Signed-off-by: Jeff Squyres <[email protected]>
jsquyres
force-pushed
the
pr/trivial-docs-updates
branch
from
fef8eb8 to
9e63d71
Compare
|
@bwbarrett It took a bunch of tries, but I think I finally got it right: RTD provides some environment variables with the info that we want. See the "docs: show version at top of first page" commit on this PR. |
bwbarrett
approved these changes
Mar 15, 2022
|
bot:aws:retest |
Signed-off-by: Jeff Squyres <[email protected]>
Ensure to always include the non-generated man pages (i.e., the pages that are simply nroff redirects to Sphinx-generated man pages). Signed-off-by: Jeff Squyres <[email protected]>
jsquyres
force-pushed
the
pr/trivial-docs-updates
branch
from
9e63d71 to
0548757
Compare
|
@bwbarrett I'm sorry to do this to you -- I just modified the last commit (man page updates -- I missed a few) and I fixed the OSHMEM man page distribution (i.e., added a new last commit) to fix #10124. This involved modifying docs/Makefile.am, and I'm not 100% confident in how I did it. Could you review again? |
bwbarrett
approved these changes
Mar 15, 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.
The first commit is some trivial docs updates on the main index page to match the text from the v4.0.x and v4.1.x docs (#10113 and #10112, respectively).
The 2nd commit is worthy of a detailed review: it deals with what version number to prominently display at the top of the front docs index page. Read the commit message for more details.
EDIT: Added a bunch of commits after the above initial description.
Fixes #10124