chore: add documentation to download and install Ecoscope GUI.

wildlife-dynamics · Oct 30, 2023 · 9690106 · 9690106
1 parent 3ef6ebf
commit 9690106
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 1 deletion.
diff --git a/doc/source/abc.md b/doc/source/abc.md
@@ -0,0 +1 @@
+Testing
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -26,6 +26,12 @@
 copyright = "2022, Wildlife Dynamics"
 author = "Wildlife Dynamics"
 
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'restructuredtext',
+    '.md': 'markdown',
+}
+
 
 # -- General configuration ---------------------------------------------------
 
@@ -41,6 +47,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
+    "myst_parser",
 ]
 
 nbsphinx_execute = "never"

diff --git a/doc/source/ecoscope_gui.rst b/doc/source/ecoscope_gui.rst
@@ -0,0 +1,31 @@
+Ecoscope GUI
+============
+
+The Ecoscope GUI provides a cross-platform, easy-to-use graphical user interface to be able to filter events and subject group observations from your EarthRanger instance, and process them with Ecoscope.
+
+The downloaded data can then be exported as either a geopackage (``.gpkg``) or a CSV (``.csv``) file.
+
+<insert screenshot>
+
+Downloads
+---------
+Requirements
+~~~~~~~~~~~~
+The GUI can be run on the following operating systems:
+
+==  ================
+OS  CPU architecture
+==  ================
+False  False
+True   False
+False  True
+True   True
+=====  ============
+
+
+===== =====
+OS    CPU architecture
+===== =====
+Windows 11 64-bit
+| --- | --- |
+| a | b
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -6,4 +6,6 @@
    :hidden:
 
    Home <self>
-   notebooks
+   notebooks;
+   ecoscope_gui
+   abc
diff --git a/environment.yml b/environment.yml
@@ -49,4 +49,5 @@ dependencies:
     - nbsphinx-multilink==1.4.1
     - sphinx-autoapi==3.0.0
     - earthranger-client==1.0.49
+    - myst-parser==2.0.0