pmix-examples/tutorial RTD setup

[naughtont3]

Overview

At the 2024Q4 ASC meeting we discussed the latest pmix use case examples. The idea of using ReadTheDocs seemed like a decent option.

See also:

• 2024Q4 ASC meeting

[naughtont3]

Starter setup:

• https://github.com/naughtont3/pmix-examples
• https://pmix-examples.readthedocs.io/en/latest/

[naughtont3]

Creating a branch to start playing with how we might want to show/present things. Starting with Example1: Business card.

• add starter files w/ Ken's business card gist naughtont3/pmix-examples#4

[naughtont3]

The standard form of RTD uses sphinx (ruby based) and RST. I looked into alternative RTD gen tool mkdocs (python based) and MD.

• start mkdocs version naughtont3/pmix-examples#5

In the end, not sure this helps a whole lot. Also, if already doing anything in OpenPMIx/PRRTE or Open MPI docs, those are all in RST/sphinx, so maybe best to just stay with one format and toolchain. No clear advantage to changing and possibly a few advantages to staying with sphinx/RST.

[naughtont3]

I think the mkdocs option is less interesting as it is yet another format. If we use Sphinx, it is same for all the other docs related to implementation and has all the nice features (well documented) for working w/ ReadTheDocs.