From ab2949d01e06c34711688bec821668767cd95b3f Mon Sep 17 00:00:00 2001 From: Robert Parker Date: Tue, 11 Jul 2023 09:55:33 -0700 Subject: [PATCH] add step for MyST Parser --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ee54c1ba..58d99f6b 100644 --- a/README.md +++ b/README.md @@ -58,9 +58,10 @@ The following provides instructions for how to build docs locally for visualizat 1. Install Python 3 for your OS if not already installed 2. Install Sphinx `pip install sphinx` 3. Install sphinx-rtd-theme `pip install sphinx-rtd-theme` -4. CD into the docs directory `cd [path to this repo]/docs` -5. Run `make html` -6. This will generate HTML in docs/build/html. Setup a web server with the web root as docs/build/html or open docs/build/html/index.html in a browser. +4. Install MyST Parser `pip install myst_parser` +5. CD into the docs directory `cd [path to this repo]/docs` +6. Run `make html` +7. This will generate HTML in docs/build/html. Setup a web server with the web root as docs/build/html or open docs/build/html/index.html in a browser. ### Vale Before pushing, run Vale and address suggestions and errors as applicable.