PMIx Reference Runtime Environment (PRRTE) |prte_ver|
=====================================================

The project is formally referred to in documentation by "PRRTE", and
the GitHub repository is ``prrte``.

.. note:: We have found that most users do not like typing the two
          consecutive ``r`` letters in the name. Hence, all of the
          internal API symbols, environment variables, MCA frameworks,
          and CLI executables all use the abbreviated ``prte`` (one
          ``r``, not two) for convenience.

Documentation locations
=======================

This documentation can be found in the following locations:

* On the web: https://docs.prrte.org/
* In the tarball: ``docs/_build/html/index.html``
* Installed: ``$prefix/share/doc/prrte/html/index.html``

Table of contents
=================

.. toctree::
   :maxdepth: 2
   :numbered:

   quickstart
   release-notes
   getting-help
   install
   configuration
   how-things-work/index
   hosts/index
   placement/index
   launching-apps/index
   notifications
   session-directory
   developers/index
   contributing
   license
   man/index
   versions
   news/index
