Merge pull request #6 from TimotheeMathieu/main

structure + doc
rlberry-py · Nov 6, 2023 · 99e5b27 · 99e5b27
2 parents e36f8f0 + 3f32937
commit 99e5b27
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -174,7 +174,7 @@ def notebook_modification_function(notebook_content, notebook_filename):
         dummy_notebook_content["cells"] + notebook_content["cells"]
     )
 
-
+jupyterlite_contents = ["tutorials"]
 # numpydoc_validation_checks = {"all"} # can be uncommented to get the warnings from numpy.
 
 sphinx_gallery_conf = {

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -5,3 +5,5 @@ numpydoc
 myst-parser
 git+https://github.com/sphinx-contrib/video
 matplotlib
+jupyterlite-sphinx
+jupyterlite-pyodide-kernel
diff --git a/docs/themes/scikit-learn-fork/nav.html b/docs/themes/scikit-learn-fork/nav.html
@@ -31,6 +31,9 @@
 
     <div class="sk-navbar-collapse collapse navbar-collapse" id="navbarSupportedContent">
       <ul class="navbar-nav mr-auto">
+        <li class="nav-item">
+          <a class="sk-nav-link nav-link" href="{{ pathto('index') }}">Index</a>
+        </li>
         <li class="nav-item">
           <a class="sk-nav-link nav-link" href="{{ pathto('installation') }}">Install</a>
         </li>

diff --git a/docs/tutorials b/docs/tutorials
@@ -0,0 +1 @@
+../tutorials
diff --git a/tutorials/quick_start.md b/tutorials/quick_start.md
@@ -0,0 +1,6 @@
+# Quick start
+
+```python
+import numpy as np
+print(np.pi)
+```