wip / checkpoint

Signed-off-by: Jeff Squyres <[email protected]>
openpmix · Aug 16, 2023 · 12ff0f7 · 12ff0f7
1 parent 76b454c
commit 12ff0f7
Show file tree

Hide file tree

Showing 126 changed files with 2,421 additions and 1,281 deletions.
diff --git a/docs/Makefile.am b/docs/Makefile.am
@@ -29,8 +29,7 @@
 
 OUTDIR             = _build
 SPHINX_CONFIG      = conf.py
-#SPHINX_OPTS       ?= -W --keep-going -j auto -T
-SPHINX_OPTS       ?= -W -T
+SPHINX_OPTS       ?= -W --keep-going -j auto
 
 # Note: it is significantly more convenient to list all the source
 # files here using wildcards (vs. listing every single .rst file).
@@ -42,16 +41,17 @@ RST_SOURCE_FILES = \
         $(srcdir)/man/man1/*.rst \
         $(srcdir)/man/man5/*.rst
 
-# JMS Remove prterun dir?
-BOGUS= \
-        $(srcdir)/man/man1/prterun/*.rst \
-        bogus
-
 EXTRA_DIST = \
         requirements.txt \
         $(SPHINX_CONFIG) \
         $(RST_SOURCE_FILES)
 
+# Note that the man pages also include files over in ../src/docs, so
+# we list them here for dependency reasons (but we don't need to list
+# them in EXTRA_DIST, so we make them distinct from RST_SOURCE_FILES).
+OTHER_RST_SOURCE_FILES = \
+        $(srcdir)/../src/docs/*.rst
+
 ###########################################################################
 
 # Note: we list all the man pages explicitly (as opposed to using
@@ -73,8 +73,6 @@ PRTE_MAN5 = \
 
 MAN_OUTDIR = $(OUTDIR)/man
 
-# JMS Do we want to ditch the subdir?
-#PRTE_MAN1_RST = $(PRTE_MAN1:%.1=man/man1/%.1.rst) man/man1/prterun/*.rst
 PRTE_MAN1_RST = $(PRTE_MAN1:%.1=man/man1/%.1.rst)
 PRTE_MAN1_BUILT = $(PRTE_MAN1:%.1=$(MAN_OUTDIR)/%.1)
 
@@ -107,6 +105,7 @@ EXTRA_DIST += \
 ALL_MAN_BUILT = \
         $(PRTE_MAN1_BUILT) $(PRTE_MAN5_BUILT)
 $(ALL_MAN_BUILT): $(RST_SOURCE_FILES) $(IMAGE_SOURCE_FILES)
+$(ALL_MAN_BUILT): $(OTHER_RST_SOURCE_FILES)
 $(ALL_MAN_BUILT): $(TEXT_SOURCE_FILES) $(SPHINX_CONFIG)
 
 # List both commands (HTML and man) in a single rule because they

diff --git a/docs/conf.py b/docs/conf.py
@@ -12,8 +12,6 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('./_ext'))
-extensions = [ ]
 
 # -- Project information -----------------------------------------------------
 
@@ -122,7 +120,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 import sphinx_rtd_theme
-extensions.extend(['recommonmark', "sphinx_rtd_theme"])
+extensions = ['recommonmark', "sphinx_rtd_theme"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/man/man1/cli-allow-run-as-root.rst b/docs/man/man1/cli-allow-run-as-root.rst
diff --git a/docs/man/man1/cli-bind-to.rst b/docs/man/man1/cli-bind-to.rst
diff --git a/docs/man/man1/cli-dash-host.rst b/docs/man/man1/cli-dash-host.rst
diff --git a/docs/man/man1/cli-debug-daemons-file.rst b/docs/man/man1/cli-debug-daemons-file.rst
diff --git a/docs/man/man1/cli-debug-daemons.rst b/docs/man/man1/cli-debug-daemons.rst
diff --git a/docs/man/man1/cli-display.rst b/docs/man/man1/cli-display.rst
diff --git a/docs/man/man1/cli-dvm-hostfile.rst b/docs/man/man1/cli-dvm-hostfile.rst
diff --git a/docs/man/man1/cli-dvm.rst b/docs/man/man1/cli-dvm.rst
diff --git a/docs/man/man1/cli-forward-signals.rst b/docs/man/man1/cli-forward-signals.rst
diff --git a/docs/man/man1/cli-launcher-hostfile.rst b/docs/man/man1/cli-launcher-hostfile.rst
diff --git a/docs/man/man1/cli-leave-session-attached.rst b/docs/man/man1/cli-leave-session-attached.rst
diff --git a/docs/man/man1/cli-map-by.rst b/docs/man/man1/cli-map-by.rst
diff --git a/docs/man/man1/cli-noprefix.rst b/docs/man/man1/cli-noprefix.rst
diff --git a/docs/man/man1/cli-notifications.rst b/docs/man/man1/cli-notifications.rst
diff --git a/docs/man/man1/cli-output.rst b/docs/man/man1/cli-output.rst
diff --git a/docs/man/man1/cli-personality.rst b/docs/man/man1/cli-personality.rst
diff --git a/docs/man/man1/cli-pmixmca.rst b/docs/man/man1/cli-pmixmca.rst
diff --git a/docs/man/man1/cli-prefix.rst b/docs/man/man1/cli-prefix.rst
diff --git a/docs/man/man1/cli-prtemca.rst b/docs/man/man1/cli-prtemca.rst
diff --git a/docs/man/man1/cli-rank-by.rst b/docs/man/man1/cli-rank-by.rst
diff --git a/docs/man/man1/cli-runtime-options.rst b/docs/man/man1/cli-runtime-options.rst
diff --git a/docs/man/man1/cli-stream-buffering.rst b/docs/man/man1/cli-stream-buffering.rst
diff --git a/docs/man/man1/cli-tmpdir-tool.rst b/docs/man/man1/cli-tmpdir-tool.rst
diff --git a/docs/man/man1/cli-tmpdir.rst b/docs/man/man1/cli-tmpdir.rst
diff --git a/docs/man/man1/cli-tune.rst b/docs/man/man1/cli-tune.rst
diff --git a/docs/man/man1/cli-x.rst b/docs/man/man1/cli-x.rst
diff --git a/docs/man/man1/deprecated-bind-to-core.rst b/docs/man/man1/deprecated-bind-to-core.rst
diff --git a/docs/man/man1/deprecated-display-allocation.rst b/docs/man/man1/deprecated-display-allocation.rst
diff --git a/docs/man/man1/deprecated-display-devel-allocation.rst b/docs/man/man1/deprecated-display-devel-allocation.rst
diff --git a/docs/man/man1/deprecated-display-devel-map.rst b/docs/man/man1/deprecated-display-devel-map.rst
diff --git a/docs/man/man1/deprecated-display-map.rst b/docs/man/man1/deprecated-display-map.rst
diff --git a/docs/man/man1/deprecated-display-topo.rst b/docs/man/man1/deprecated-display-topo.rst
diff --git a/docs/man/man1/deprecated-gmca.rst b/docs/man/man1/deprecated-gmca.rst
diff --git a/docs/man/man1/deprecated-mca.rst b/docs/man/man1/deprecated-mca.rst
diff --git a/docs/man/man1/deprecated-merge-stderr-to-stdout.rst b/docs/man/man1/deprecated-merge-stderr-to-stdout.rst
diff --git a/docs/man/man1/deprecated-output-directory.rst b/docs/man/man1/deprecated-output-directory.rst
diff --git a/docs/man/man1/deprecated-output-filename.rst b/docs/man/man1/deprecated-output-filename.rst
diff --git a/docs/man/man1/deprecated-report-bindings.rst b/docs/man/man1/deprecated-report-bindings.rst
diff --git a/docs/man/man1/deprecated-tag-output.rst b/docs/man/man1/deprecated-tag-output.rst
diff --git a/docs/man/man1/deprecated-timestamp-output.rst b/docs/man/man1/deprecated-timestamp-output.rst
diff --git a/docs/man/man1/deprecated-xml.rst b/docs/man/man1/deprecated-xml.rst
diff --git a/docs/man/man1/help-schizo-hostfile-syntax.rst b/docs/man/man1/help-schizo-hostfile-syntax.rst
diff --git a/docs/man/man1/help-schizo-relative-indexing.rst b/docs/man/man1/help-schizo-relative-indexing.rst
diff --git a/docs/man/man1/help-schizo-session-dir.rst b/docs/man/man1/help-schizo-session-dir.rst
diff --git a/docs/man/man1/index.rst b/docs/man/man1/index.rst
@@ -7,5 +7,5 @@ Commands (section 1)
    prte.1.rst
    prte_info.1.rst
    prted.1.rst
-   prterun.1.rst
+   prterun/prterun.1.rst
    prun.1.rst
diff --git a/docs/man/man1/placement-diagnostics.rst b/docs/man/man1/placement-diagnostics.rst
diff --git a/docs/man/man1/placement-examples.rst b/docs/man/man1/placement-examples.rst
diff --git a/docs/man/man1/placement-fundamentals.rst b/docs/man/man1/placement-fundamentals.rst
diff --git a/docs/man/man1/placement-limits.rst b/docs/man/man1/placement-limits.rst
diff --git a/docs/man/man1/placement-overview.rst b/docs/man/man1/placement-overview.rst
diff --git a/docs/man/man1/placement-rankfiles.rst b/docs/man/man1/placement-rankfiles.rst
diff --git a/docs/man/man1/prterun/cli-allow-run-as-root.rst b/docs/man/man1/prterun/cli-allow-run-as-root.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-allow-run-as-root.rst
diff --git a/docs/man/man1/prterun/cli-bind-to.rst b/docs/man/man1/prterun/cli-bind-to.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-bind-to.rst
diff --git a/docs/man/man1/prterun/cli-dash-host.rst b/docs/man/man1/prterun/cli-dash-host.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-dash-host.rst
diff --git a/docs/man/man1/prterun/cli-debug-daemons-file.rst b/docs/man/man1/prterun/cli-debug-daemons-file.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-debug-daemons-file.rst
diff --git a/docs/man/man1/prterun/cli-debug-daemons.rst b/docs/man/man1/prterun/cli-debug-daemons.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-debug-daemons.rst
diff --git a/docs/man/man1/prterun/cli-display.rst b/docs/man/man1/prterun/cli-display.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-display.rst
diff --git a/docs/man/man1/prterun/cli-dvm-hostfile.rst b/docs/man/man1/prterun/cli-dvm-hostfile.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-dvm-hostfile.rst
diff --git a/docs/man/man1/prterun/cli-dvm.rst b/docs/man/man1/prterun/cli-dvm.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-dvm.rst
diff --git a/docs/man/man1/prterun/cli-forward-signals.rst b/docs/man/man1/prterun/cli-forward-signals.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-forward-signals.rst
diff --git a/docs/man/man1/prterun/cli-launcher-hostfile.rst b/docs/man/man1/prterun/cli-launcher-hostfile.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-launcher-hostfile.rst
diff --git a/docs/man/man1/prterun/cli-leave-session-attached.rst b/docs/man/man1/prterun/cli-leave-session-attached.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-leave-session-attached.rst
diff --git a/docs/man/man1/prterun/cli-map-by.rst b/docs/man/man1/prterun/cli-map-by.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-map-by.rst
diff --git a/docs/man/man1/prterun/cli-noprefix.rst b/docs/man/man1/prterun/cli-noprefix.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-noprefix.rst
diff --git a/docs/man/man1/prterun/cli-notifications.rst b/docs/man/man1/prterun/cli-notifications.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-notifications.rst
diff --git a/docs/man/man1/prterun/cli-output.rst b/docs/man/man1/prterun/cli-output.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-output.rst
diff --git a/docs/man/man1/prterun/cli-personality.rst b/docs/man/man1/prterun/cli-personality.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-personality.rst
diff --git a/docs/man/man1/prterun/cli-pmixmca.rst b/docs/man/man1/prterun/cli-pmixmca.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-pmixmca.rst
diff --git a/docs/man/man1/prterun/cli-prefix.rst b/docs/man/man1/prterun/cli-prefix.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-prefix.rst
diff --git a/docs/man/man1/prterun/cli-prtemca.rst b/docs/man/man1/prterun/cli-prtemca.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-prtemca.rst
diff --git a/docs/man/man1/prterun/cli-rank-by.rst b/docs/man/man1/prterun/cli-rank-by.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-rank-by.rst
diff --git a/docs/man/man1/prterun/cli-runtime-options.rst b/docs/man/man1/prterun/cli-runtime-options.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-runtime-options.rst
diff --git a/docs/man/man1/prterun/cli-stream-buffering.rst b/docs/man/man1/prterun/cli-stream-buffering.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-stream-buffering.rst
diff --git a/docs/man/man1/prterun/cli-tmpdir-tool.rst b/docs/man/man1/prterun/cli-tmpdir-tool.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-tmpdir-tool.rst
diff --git a/docs/man/man1/prterun/cli-tmpdir.rst b/docs/man/man1/prterun/cli-tmpdir.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-tmpdir.rst
diff --git a/docs/man/man1/prterun/cli-tune.rst b/docs/man/man1/prterun/cli-tune.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-tune.rst
diff --git a/docs/man/man1/prterun/cli-x.rst b/docs/man/man1/prterun/cli-x.rst
@@ -0,0 +1 @@
+../../../../src/docs/cli-x.rst
diff --git a/docs/man/man1/prterun/deprecated-bind-to-core.rst b/docs/man/man1/prterun/deprecated-bind-to-core.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-bind-to-core.rst
diff --git a/docs/man/man1/prterun/deprecated-display-allocation.rst b/docs/man/man1/prterun/deprecated-display-allocation.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-display-allocation.rst
diff --git a/docs/man/man1/prterun/deprecated-display-devel-allocation.rst b/docs/man/man1/prterun/deprecated-display-devel-allocation.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-display-devel-allocation.rst
diff --git a/docs/man/man1/prterun/deprecated-display-devel-map.rst b/docs/man/man1/prterun/deprecated-display-devel-map.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-display-devel-map.rst
diff --git a/docs/man/man1/prterun/deprecated-display-map.rst b/docs/man/man1/prterun/deprecated-display-map.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-display-map.rst
diff --git a/docs/man/man1/prterun/deprecated-display-topo.rst b/docs/man/man1/prterun/deprecated-display-topo.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-display-topo.rst
diff --git a/docs/man/man1/prterun/deprecated-gmca.rst b/docs/man/man1/prterun/deprecated-gmca.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-gmca.rst
diff --git a/docs/man/man1/prterun/deprecated-mca.rst b/docs/man/man1/prterun/deprecated-mca.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-mca.rst
diff --git a/docs/man/man1/prterun/deprecated-merge-stderr-to-stdout.rst b/docs/man/man1/prterun/deprecated-merge-stderr-to-stdout.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-merge-stderr-to-stdout.rst
diff --git a/docs/man/man1/prterun/deprecated-output-directory.rst b/docs/man/man1/prterun/deprecated-output-directory.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-output-directory.rst
diff --git a/docs/man/man1/prterun/deprecated-output-filename.rst b/docs/man/man1/prterun/deprecated-output-filename.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-output-filename.rst
diff --git a/docs/man/man1/prterun/deprecated-report-bindings.rst b/docs/man/man1/prterun/deprecated-report-bindings.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-report-bindings.rst
diff --git a/docs/man/man1/prterun/deprecated-tag-output.rst b/docs/man/man1/prterun/deprecated-tag-output.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-tag-output.rst
diff --git a/docs/man/man1/prterun/deprecated-timestamp-output.rst b/docs/man/man1/prterun/deprecated-timestamp-output.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-timestamp-output.rst
diff --git a/docs/man/man1/prterun/deprecated-xml.rst b/docs/man/man1/prterun/deprecated-xml.rst
@@ -0,0 +1 @@
+../../../../src/docs/deprecated-xml.rst
diff --git a/docs/man/man1/prterun/help-schizo-hostfile-syntax.rst b/docs/man/man1/prterun/help-schizo-hostfile-syntax.rst
@@ -0,0 +1 @@
+../../../../src/docs/help-schizo-hostfile-syntax.rst
diff --git a/docs/man/man1/prterun/help-schizo-relative-indexing.rst b/docs/man/man1/prterun/help-schizo-relative-indexing.rst
@@ -0,0 +1 @@
+../../../../src/docs/help-schizo-relative-indexing.rst
diff --git a/docs/man/man1/prterun/help-schizo-session-dir.rst b/docs/man/man1/prterun/help-schizo-session-dir.rst
@@ -0,0 +1 @@
+../../../../src/docs/help-schizo-session-dir.rst
diff --git a/docs/man/man1/prterun/placement-diagnostics.rst b/docs/man/man1/prterun/placement-diagnostics.rst
@@ -0,0 +1 @@
+../../../../src/docs/placement-diagnostics.rst
diff --git a/docs/man/man1/prterun/placement-examples.rst b/docs/man/man1/prterun/placement-examples.rst
@@ -0,0 +1 @@
+../../../../src/docs/placement-examples.rst
diff --git a/docs/man/man1/prterun/placement-fundamentals.rst b/docs/man/man1/prterun/placement-fundamentals.rst
@@ -0,0 +1 @@
+../../../../src/docs/placement-fundamentals.rst
diff --git a/docs/man/man1/prterun/placement-limits.rst b/docs/man/man1/prterun/placement-limits.rst
@@ -0,0 +1 @@
+../../../../src/docs/placement-limits.rst
diff --git a/docs/man/man1/prterun/placement-overview.rst b/docs/man/man1/prterun/placement-overview.rst
@@ -0,0 +1 @@
+../../../../src/docs/placement-overview.rst
diff --git a/docs/man/man1/prterun/placement-rankfiles.rst b/docs/man/man1/prterun/placement-rankfiles.rst
@@ -0,0 +1 @@
+../../../../src/docs/placement-rankfiles.rst
diff --git a/docs/man/man1/prterun.1.rst → docs/man/man1/prterun/prterun.1.rst b/docs/man/man1/prterun.1.rst → docs/man/man1/prterun/prterun.1.rst