# PMIx Reference RunTime Environment (PRRTE)

PRRTE is [the PMIx Reference RunTime
Environment](https://github.com/openpmix/prrte)

## Official documentation

The PRRTE documentation can be viewed in the following ways:

1. Online at https://docs.prrte.org/
1. 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.org/en/latest/developers/sphinx.html