Added doc

timtreis · Jun 26, 2023 · e21ff24 · e21ff24
1 parent 5f045c2
commit e21ff24
Show file tree

Hide file tree

Showing 5 changed files with 166 additions and 203 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -1,38 +1,14 @@
 # API
 
-## Preprocessing
-
-```{eval-rst}
-.. module:: gefslim.pp
-.. currentmodule:: gefslim
-
-.. autosummary::
-    :toctree: generated
-
-    pp.basic_preproc
-```
-
-## Tools
-
 ```{eval-rst}
-.. module:: gefslim.tl
-.. currentmodule:: gefslim
-
-.. autosummary::
-    :toctree: generated
-
-    tl.basic_tool
+.. module:: gefslim
 ```
 
-## Plotting
+## Functions
 
 ```{eval-rst}
-.. module:: gefslim.pl
-.. currentmodule:: gefslim
-
 .. autosummary::
     :toctree: generated
 
-    pl.basic_plot
-    pl.BasicClass
+    GEF
 ```
diff --git a/docs/index.md b/docs/index.md
@@ -4,13 +4,13 @@
 
 ```{toctree}
 :hidden: true
-:maxdepth: 1
+:maxdepth: 2
 
 api.md
 changelog.md
 template_usage.md
 contributing.md
 references.md
 
-notebooks/example
+notebooks/gefslim
 ```
diff --git a/docs/notebooks/example.ipynb b/docs/notebooks/example.ipynb
diff --git a/examples/gefslim.ipynb → docs/notebooks/gefslim.ipynb b/examples/gefslim.ipynb → docs/notebooks/gefslim.ipynb
@@ -10,6 +10,14 @@
     "%autoreload 2"
    ]
   },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Minimal access to `.gef` files"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,
@@ -318,7 +326,7 @@
     {
      "data": {
       "text/plain": [
-       "<matplotlib.collections.PathCollection at 0x28eec0c40>"
+       "<matplotlib.collections.PathCollection at 0x2999f8ee0>"
       ]
      },
      "execution_count": 6,