Skip to content

Commit 846a4a6

Browse files
committed
wip / first cut
This is terribly incomplete, but just putting something here so that others can see / get a flavor of what's going on. Signed-off-by: Jeff Squyres <[email protected]>
1 parent 7b87ae4 commit 846a4a6

File tree

6 files changed

+43
-7
lines changed

6 files changed

+43
-7
lines changed

docs/_ext

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../3rd-party/prrte/docs/_ext

docs/conf.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@
1010
# add these directories to sys.path here. If the directory is relative to the
1111
# documentation root, use os.path.abspath to make it absolute, like shown here.
1212
#
13-
# import os
14-
# import sys
15-
# sys.path.insert(0, os.path.abspath('.'))
13+
import os
14+
import sys
15+
sys.path.insert(0, os.path.abspath('./_ext'))
16+
extensions = [ 'prte' ]
1617

1718
# -- Project information -----------------------------------------------------
1819

@@ -116,11 +117,11 @@
116117
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
117118
# ones.
118119
import sphinx_rtd_theme
119-
extensions = [
120+
extensions.extend([
120121
'recommonmark',
121122
"sphinx_rtd_theme",
122123
"sphinx.ext.extlinks",
123-
]
124+
])
124125

125126
# Add any paths that contain templates here, relative to this directory.
126127
templates_path = ['_templates']

docs/man-openmpi/man1/mpirun.1.rst

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,8 +174,39 @@ By default, Open MPI defines that a "processing element" is a
174174
processor core. However, if ``--use-hwthread-cpus`` is specified on the
175175
mpirun command line, then a "processing element" is a hardware thread.
176176

177-
OPTIONS
178-
-------
177+
OPTIONS (NEW / DYNAMICALLY IMPORTED FROM PRTE)
178+
----------------------------------------------
179+
180+
From prterun(1)
181+
^^^^^^^^^^^^^^^
182+
183+
These options are directly from ``prterun(1)``:
184+
185+
.. include:: mpirun/help-schizo-cli.rst
186+
187+
Open MPI-specific options
188+
^^^^^^^^^^^^^^^^^^^^^^^^^
189+
190+
These options are specific to Open MPI:
191+
192+
.. include:: mpirun/help-schizo-ompi.rst
193+
194+
Deprecated options
195+
^^^^^^^^^^^^^^^^^^
196+
197+
These are deprecated options:
198+
199+
.. include:: mpirun/help-schizo-deprecated.rst
200+
201+
OPTIONS (OLD / HARD-CODED CONTENT -- TO BE DELETED)
202+
---------------------------------------------------
203+
204+
.. admonition:: This is old content
205+
:class: error
206+
207+
This is the old section of manually hard-coded content. It will
208+
likely someday be deleted and replaced with the dynamic content
209+
from prterun.
179210

180211
mpirun will send the name of the directory where it was invoked on the
181212
local node to each of the remote nodes, and attempt to change to that
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../3rd-party/prrte/src/docs/help-schizo-cli.rst
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../3rd-party/prrte/src/docs/help-schizo-deprecated.rst
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../../3rd-party/prrte/src/docs/mca/help-schizo-ompi.rst

0 commit comments

Comments
 (0)