README.md

PMIx Reference Runtime Environment (PRRTE)

PRRTE is the PMIx Reference Run Time Environment

Official documentation

The PRRTE documentation can be viewed in the following ways:

1. Online at https://docs.prrte.org/
2. In self-contained (i.e., suitable for local viewing, without an internet connection) in official distribution tarballs under docs/_build/html/index.html.

Building the documentation locally

The source code for PRRTE's docs can be found in the PRRTE Git repository under the docs folder.

Developers who clone the PRRTE Git repository will not have the HTML documentation and man pages by default; it must be built. Instructions for how to build the PRRTE documentation can be found here: https://docs.prrte.orf/en/master/developers/prerequisites.html#sphinx.