The OpenPMIx documentation can be viewed in the following ways:
- Online at https://docs.openpmix.org/
- In self-contained (i.e., suitable for local viewing, without an
internet connection) in official distribution tarballs under
docs/_build/html/index.html
.
The source code for OpenPMIx's docs can be found in the OpenPMIx Git
repository under the docs
folder.
Developers who clone the OpenPMIx Git repository will not have the HTML documentation and man pages by default; it must be built. Instructions for how to build the OpenPMIx documentation can be found here: https://docs.openpmix.org/en/master/developers/prerequisites.html#sphinx.