Basic documentation (#44)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: sagar87

.gitignore

@@ -28,3 +28,6 @@ __pycache__/
 /.vscode/
 
 format.sh
+
+# jupyter checkpoints
+.ipynb_checkpoints

docs/Makefile

@@ -21,4 +21,3 @@ help:
 
 clean:
 	rm -r "$(BUILDDIR)"
-	rm -r "generated"

docs/api.md

@@ -118,7 +118,9 @@
 nitpick_ignore = [
     # If building the documentation fails because of a missing link that is outside your control,
     # you can add an exception to this list.
-    #     ("py:class", "igraph.Graph"),
+    ("py:class", "spatialdata._core.spatialdata.SpatialData"),
+    ("py:class", "xarray.core.dataarray.DataArray"),
+    ("py:class", "matplotlib.axes._axes.Axes"),
 ]
 
 

docs/conf.py

@@ -4,13 +4,31 @@
 
 ```{toctree}
 :hidden: true
-:maxdepth: 1
+:maxdepth: 2
+:caption: API
+
+preprocessing.rst
+plotting.rst
+
+```
+
+```{toctree}
+:hidden: true
+:maxdepth: 2
+:caption: Tutorials
+
+notebooks/preprocessing
+notebooks/demo
+
+```
+
+```{toctree}
+:hidden: true
+:maxdepth: 2
+:caption: Other
 
-api.md
 changelog.md
 template_usage.md
 contributing.md
 references.md
-
-notebooks/demo
 ```