Skip to content

Commit b48f0c2

Browse files
committed
WIP A few notes about python/pip/sphinx
Signed-off-by: Jeff Squyres <[email protected]>
1 parent 6b3ef28 commit b48f0c2

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/developers/sphinx.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,19 @@ MPI Git clone directory:
2727

2828
.. code-block:: sh
2929
30+
# Create the Python virtual environment
3031
shell$ cd TOP_OF_OPEN_MPI_GIT_CLONE
3132
shell$ python3 -m venv ompi-docs-venv
33+
# Or: python3 -m virtualenv ompi-docs-venv
34+
# Or: virtualenv --python=python3 ompi-docs-venv
35+
36+
# Activate the virtual environment
3237
shell$ . ./ompi-docs-venv/bin/activate
38+
39+
# Notice that the shell prompt changes
40+
# Now install the required Python modules
3341
(ompi-docs-venv) shell$ pip3 install -r docs/requirements.txt
42+
# Or: python3 -m pip install install -r docs/requirements.txt
3443
3544
Note that sourcing the ``activate`` script will change your prompt to
3645
put the name of your virtual environment directory at the front, just
@@ -53,6 +62,7 @@ root privileges):
5362
5463
shell$ cd TOP_OF_OPEN_MPI_GIT_CLONE
5564
shell$ pip3 install -r docs/requirements.txt
65+
# Or: python3 -m pip install install -r docs/requirements.txt
5666
5767
This will install Sphinx and some Python modules required for building
5868
the Open MPI documentation in a system-wide location.
@@ -76,6 +86,7 @@ permissions to run this command):
7686
7787
shell$ cd TOP_OF_OPEN_MPI_GIT_CLONE
7888
shell$ pip3 install --user -r docs/requirements.txt
89+
# Or: python3 -m pip install install -r docs/requirements.txt
7990
8091
This will install Sphinx and some Python modules required for building
8192
the Open MPI documentation in a system-wide location.

0 commit comments

Comments
 (0)