Merge pull request #79 from GreenBankObservatory/cat-devel

Add more docs - GitHub tests and docs build pass
GreenBankObservatory · Aug 28, 2023 · 03ad87f · 03ad87f
2 parents 5ad07aa + 8c790e0
commit 03ad87f
Show file tree

Hide file tree

Showing 4 changed files with 690 additions and 11 deletions.
diff --git a/docs/source/background/gbo_context.rst b/docs/source/background/gbo_context.rst
@@ -0,0 +1,22 @@
+**************************
+Context Within GBO Systems
+**************************
+
+Background 
+==========
+
+GBTIDL
+------
+
+`GBTIDL` is the current software used to calibrate SDFITS files from the GBT. 
+
+Requirements
+============
+
+At its core, `dysh` needs to read in an SDFITS file and ultimately output calibrated data.
+
+.. mermaid::
+
+    flowchart LR
+        A[SDFITS File] --> B[Dysh]
+        B --> C[Output Data]
diff --git a/docs/source/background/index.rst b/docs/source/background/index.rst
@@ -0,0 +1,11 @@
+**********
+Background
+**********
+
+Why does this exist?
+
+.. toctree::
+   :maxdepth: 2
+
+   gbo_context
+   sdfits_files