Feature/add nbsphinx (#21)

* install nbsphinx * fix license * use nbsphinx in building the docs * add test tutorial docs * only test on PRs
piskunow · Nov 22, 2023 · 7318078 · 7318078
1 parent 8231e3f
commit 7318078
Show file tree

Hide file tree

Showing 7 changed files with 390 additions and 30 deletions.
diff --git a/.cookiecutter.json b/.cookiecutter.json
@@ -9,7 +9,7 @@
   "email": "[email protected]",
   "friendly_name": "KPM Tools",
   "github_user": "piskunow",
-  "license": "MIT",
+  "license": "BSD 2-Clause",
   "package_name": "kpm_tools",
   "project_name": "kpm-tools",
   "version": "0.0.0"

diff --git a/docs/conf.py b/docs/conf.py
@@ -7,6 +7,7 @@
     "sphinx.ext.napoleon",
     "sphinx_click",
     "myst_parser",
+    "nbsphinx",
 ]
 autodoc_typehints = "description"
 html_theme = "furo"
diff --git a/docs/index.md b/docs/index.md
@@ -14,6 +14,7 @@ hidden:
 maxdepth: 1
 ---
 
+Tutorials <tutorials>
 usage
 reference
 contributing

diff --git a/docs/tutorials.md b/docs/tutorials.md
@@ -0,0 +1,9 @@
+# 📘 Tutorials
+
+```{toctree}
+---
+maxdepth: 1
+---
+
+tutorial_01_test
+```
diff --git a/noxfile.py b/noxfile.py
@@ -227,7 +227,15 @@ def docs(session: Session) -> None:
     """Build and serve the documentation with live reloading on file changes."""
     args = session.posargs or ["--open-browser", "docs", "docs/_build"]
     session.install(".")
-    session.install("sphinx", "sphinx-autobuild", "sphinx-click", "furo", "myst-parser")
+    session.install(
+        "sphinx",
+        "sphinx-autobuild",
+        "sphinx-click",
+        "furo",
+        "myst-parser",
+        "nbsphinx",
+        "pandoc",
+    )
 
     build_dir = Path("docs", "_build")
     if build_dir.exists():