Multiple commits #1870
Merged
Multiple commits #1870
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
Start with process placement - just recover the text, but lots of reformatting is going to be required before release. Add in the "host" detail and begin to cleanup formatting. Use the "orphan" designator to eliminate the need for an "all" file to include every snippet so that Sphinx doesn't error out because a snippet isn't referenced. Try to further cleanup the host/hostfile docs by restoring some of the cross-referencing. Unfortunately, I had to eliminate the labels as including files in more than one place causes Sphinx to complain about duplicate labels. Signed-off-by: Ralph Castain <rhc@pmix.org> (cherry picked from commit 9ab1039)
See lengthy comment in conf.py for an explanation. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 1f6442d)
Update the src/docs/prrte-rst-content/README.txt file with instructions for both downstream packagers and PRRTE docs authors with the changes that we just recently made in this area. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 168ed5b)
Convert all non-component show_help text files to RST and consolidate them into src/docs/show-help-files. This makes all the show_help files be the same format and in the same place. In most cases, this was acomplished by "git mv .../help-BLAH.txt src/docs/show-help-files/help-BLAH.rst" and then hand-editing the file to convert it to RST. In some cases, git recognized the file "move" and rename; in other cases it recorded it as deleting the original .txt file and addition of a "new" .rst file. Note: in one case, the target RST file already existed (help-prted), so the content from the source text file was appended to the end of the existing RST file. Conversion of component show_help files will require some additional m4 + infrastructure changes, and will be in a future commit. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 4676a3c)
Signed-off-by: Ralph Castain <rhc@pmix.org>
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.
Begin to restore the detailed help topics
Start with process placement - just recover
the text, but lots of reformatting is going
to be required before release.
Add in the "host" detail and begin to cleanup
formatting.
Use the "orphan" designator to eliminate the
need for an "all" file to include
every snippet so that Sphinx doesn't error out
because a snippet isn't referenced. Try to
further cleanup the host/hostfile docs by
restoring some of the cross-referencing.
Unfortunately, I had to eliminate the labels
as including files in more than one place causes
Sphinx to complain about duplicate labels.
Signed-off-by: Ralph Castain rhc@pmix.org
(cherry picked from commit 9ab1039)
docs: add prrte-rst-content to conf.py's exclude_patterns
See lengthy comment in conf.py for an explanation.
Signed-off-by: Jeff Squyres jeff@squyres.com
(cherry picked from commit 1f6442d)
src/docs: update README.txt
Update the src/docs/prrte-rst-content/README.txt file with
instructions for both downstream packagers and PRRTE docs authors with
the changes that we just recently made in this area.
Signed-off-by: Jeff Squyres jeff@squyres.com
(cherry picked from commit 168ed5b)
Consolidate non-component show_help files
Convert all non-component show_help text files to RST and consolidate
them into src/docs/show-help-files. This makes all the show_help
files be the same format and in the same place.
In most cases, this was acomplished by "git mv .../help-BLAH.txt
src/docs/show-help-files/help-BLAH.rst" and then hand-editing the file
to convert it to RST. In some cases, git recognized the file "move"
and rename; in other cases it recorded it as deleting the original
.txt file and addition of a "new" .rst file.
Note: in one case, the target RST file already existed (help-prted),
so the content from the source text file was appended to the end of
the existing RST file.
Conversion of component show_help files will require some additional
m4 + infrastructure changes, and will be in a future commit.
Signed-off-by: Jeff Squyres jeff@squyres.com
(cherry picked from commit 4676a3c)
Add missing file
Signed-off-by: Ralph Castain rhc@pmix.org
bot:notacherrypick