Add non-technical documentation to PRIMO website (NEMRI-org#34)

* DOC: Add non-technical documentation to PRIMO website * Update section tile of the non-technical documentation * Add quickstart to the spell check list
radhakrishnatg · Oct 10, 2024 · 4381940 · 4381940
1 parent 5755def
commit 4381940
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/.github/wordlist.txt b/.github/wordlist.txt
@@ -61,6 +61,7 @@ np
 num
 param
 pre
+quickstart
 scikit
 shapefile
 shapefiles

diff --git a/docs/_static/PRIMO_Tool_Flyer.pdf b/docs/_static/PRIMO_Tool_Flyer.pdf
diff --git a/docs/_static/PRIMO_Tool_Flyer.png b/docs/_static/PRIMO_Tool_Flyer.png
diff --git a/docs/documentation.rst b/docs/documentation.rst
@@ -0,0 +1,7 @@
+PRIMO Explained in One Page
+===========================
+
+
+.. figure:: _static/PRIMO_Tool_Flyer.png
+
+Please feel free to download :download:`this documentation <_static/PRIMO_Tool_Flyer.pdf>` and share it as needed.
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,6 +4,7 @@
 PRIMO - The P&A Project Optimizer
 ==============================================================
 
+
 PRIMO Description
 -----------------
 In support of the Methane Emissions Reduction Program (MERP) and under the National Methane Emissions Reduction Initiative (NEMRI), 
@@ -74,6 +75,7 @@ Contents
 .. toctree::
     :maxdepth: 1
 
+    documentation
     install
     quickstart
     workflow