Merge pull request #5 from spaceml-org/doc

docs

MANIFEST.in

@@ -0,0 +1,2 @@
+include karman/*.pk
+include karman/*.csv

README.md

@@ -1,4 +1,4 @@
-[![Install package and run tests](https://github.com/spaceml-org/karman/actions/workflows/install.yaml/badge.svg)](https://github.com/spaceml-org/karman/actions/workflows/install.yaml) 
+[![Install package](https://github.com/spaceml-org/karman/actions/workflows/build.yml/badge.svg)](https://github.com/spaceml-org/karman/actions/workflows/build.yml) 
 
 Karman - Data Driven Thermospheric Density Nowcast and Forecast with Machine Learning
 <!-- PROJECT LOGO -->
@@ -87,7 +87,7 @@ If you would like to learn more about or cite the techniques Karman uses, please
 }
 ```
 
-* Shreshth Malik, James Walsh, Giacomo Acciarini, Thomas Berger, At{\i}l{\i}m G{\"u}ne{\c{s}}} Baydin. 2023. ["High-Cadence Thermospheric Density Estimation enabled by Machine Learning on Solar Imagery"](https://ml4physicalsciences.github.io/2023/files/NeurIPS_ML4PS_2023_237.pdf). In NeurIPS, Machine Learning and the Physical Sciences Workshop.
+* Shreshth Malik, James Walsh, Giacomo Acciarini, Thomas Berger, Atılım Güneş Baydin. 2023. ["High-Cadence Thermospheric Density Estimation enabled by Machine Learning on Solar Imagery"](https://ml4physicalsciences.github.io/2023/files/NeurIPS_ML4PS_2023_237.pdf). In NeurIPS, Machine Learning and the Physical Sciences Workshop.
 
 ```bibtex
 @article{malik2023high,

docs/api.rst

@@ -1,12 +1,12 @@
 .. _api:
 
 API
-====
+#######
 
 Karman API
 
+.. currentmodule:: karman
+
 .. autosummary::
-   :toctree: _autosummary
+   :toctree: _autosummary/
    :recursive:
-
-   karman

docs/conf.py

@@ -61,7 +61,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", ".DS_Store"]
+exclude_patterns = ["_build", ".DS_Store",'jupyter_execute/**/*.ipynb','jupyter_execute/*.ipynb']
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -94,7 +94,9 @@
 nb_execution_mode = "force"
 
 nb_execution_excludepatterns = [
-#    "target_notebook.ipynb",
+    "data_analysis.ipynb",
+    "tutorial_forecast.ipynb",
+    "tutorial_nowcast.ipynb"
 ]
 
 latex_engine = "xelatex"

docs/credits.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Credits\n",
+    "# Credits\n",
     "\n",
     "<div style=\"display: flex; justify-content: space-evenly; align-items: center;\">\n",
     "    <img src=\"_static/fdl2021_badge.png\" alt=\"NASA FDL 2021\" style=\"width: 100px; height: auto;\"/>\n",
@@ -43,6 +43,11 @@
     "* William Fawcett\n",
     "* Atılım Güneş Baydin\n"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
   }
  ],
  "metadata": {

docs/index.md

@@ -25,17 +25,5 @@ credits
 :caption: Contents
 
 tutorials
-```
-
-```{toctree}
-:maxdepth: 1
-:caption: API documentation
-
-karman package <_autosummary/karman>
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-```
+api
+```