feat: add notebook to documentation

swiss-seismological-service · Jan 10, 2024 · 25963c8 · 25963c8
1 parent 21f9d18
commit 25963c8
Show file tree

Hide file tree

Showing 5 changed files with 1,430 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Measure your seismicity with **SeismoStats**, a Python package for seismicity analysis.
 
-### Start developing:
+## Start developing:
 
 ```
 # just use a basic virtual environment
@@ -21,7 +21,7 @@ pip install -e '.[dev]'
 tox
 ```
 
-### Use this repository inside another environment/code
+## Use this repository inside another environment/code
 
 ```
 # use it locally, being able to switch back and forth doing changes
@@ -38,7 +38,7 @@ pip install git+https://github.com/swiss-seismological-service/catalog-tools.git
 pip install --force-reinstall git+https://github.com/swiss-seismological-service/catalog-tools.git
 ```
 
-### Problems with geos
+## Problems with geos
 
 ```
 1. geos_c.h not found

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -16,6 +16,8 @@
 
 extensions = [
     "myst_parser",
+    "sphinx.ext.autosectionlabel",
+    "nbsphinx",
 ]
 
 templates_path = ['_templates']

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -10,6 +10,7 @@ Check out the {doc}`usage` section for further information, including how to
 :maxdepth: 2
 
 usage
+notebooks/catalog_examples
 ```
 
 ## Indices and tables
-Original file line number
+Diff line change
@@ Expand Up @@
     :maxdepth: 2
     usage
+    notebooks/catalog_examples
     ```
     ## Indices and tables
@@ Expand Down @@