update docs

docs/Project.toml

@@ -0,0 +1,7 @@
+[deps]
+Documenter           = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
+StereoSSAM           = "4c4340ea-7f9e-46b4-8512-61f1f6c41a11"
+
+[compat]
+Documenter = "1.3"

docs/make.jl

@@ -1,4 +1,25 @@
 using Documenter
+using DocumenterInterLinks
 using StereoSSAM
 
-makedocs(; sitename="StereoSSAM.jl")
+links = InterLinks(
+    # "CategoricalArrays" => "https://categoricalarrays.juliadata.org/stable/",
+    # "DimensionalData" => "https://rafaqz.github.io/DimensionalData.jl/dev/",
+    "Muon" => "https://scverse.org/Muon.jl/dev/",
+    "SparseArrays" => (
+        "https://docs.julialang.org/en/v1/stdlib/SparseArrays/",
+        "https://docs.julialang.org/en/v1/objects.inv",
+    ),
+)
+
+makedocs(;
+    sitename="StereoSSAM.jl",
+    pages=[
+        "Home" => "index.md",
+        "Example analysis" => "examples/ExampleAnalysis.md",
+        "Reference API" => "api.md",
+    ],
+    authors="Niklas Müller-Bötticher",
+    plugins=[links],
+    format=Documenter.HTML(; size_threshold_ignore=["examples/ExampleAnalysis.md"]),
+)

docs/src/api.md

@@ -0,0 +1,20 @@
+# Reference API
+
+Documentation for `StereoSSAM.jl`'s public interface.
+
+## Index
+
+```@index
+Pages = ["api.md"]
+```
+
+## API
+
+```@autodocs
+Modules = [
+    StereoSSAM.IO,
+    StereoSSAM.Utils,
+    StereoSSAM.KDE,
+    StereoSSAM.LocalMax,
+]
+```

docs/src/index.md

@@ -1,15 +1,20 @@
-# StereoSSAM.jl Documentation
+# StereoSSAM.jl
 
-```@contents
-```
+TODO general introduction
 
-## Functions
+reference to python repo
 
-```@autodocs
-Modules = [StereoSSAM]
-```
+## Citation
+
+If you use `StereoSSAM.jl` for your research please consider citing
+TODO
 
 ## Index
 
-```@index
-```
+```@contents
+Pages = [
+    "examples/ExampleAnalysis.md",
+    "api.md",
+]
+Depth = 3
+```