docs: add notebooks to sphinx docs

Author: JulesBelveze

.github/workflows/documentation.yaml

@@ -15,7 +15,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install sphinx furo sphinx-copybutton sphinxext-opengraph myst-parser autodoc_pydantic
+          pip install sphinx furo sphinx-copybutton sphinxext-opengraph myst-parser autodoc_pydantic nbsphinx
           sudo apt-get install pandoc
       - name: Build and Commit
         uses: sphinx-notes/pages@master

docs/conf.py

@@ -27,6 +27,7 @@
     "sphinx_copybutton",
     "sphinx.ext.githubpages",
     "sphinxcontrib.autodoc_pydantic",
+    "nbsphinx",
     "myst_parser"
 ]
 autoclass_content = 'both'

docs/faq.rst

@@ -23,15 +23,16 @@ Content
    :caption: Getting started
 
    installation
-   concepts
-   faq
+   tutorials/Training
+   tutorials/Distillation
 
 
 .. toctree::
    :maxdepth: 1
    :caption: Bertsqueeze
 
    overview
+   concepts
    assistants
    distillation
    models
@@ -40,7 +41,7 @@ Content
    :maxdepth: 2
    :caption: API References
 
-   api`
+   api
    GitHub Repository <https://github.com/JulesBelveze/bert-squeeze>
 
 

docs/index.rst

@@ -5,7 +5,15 @@
    "id": "fa3659b8",
    "metadata": {},
    "source": [
-    "# Training a simple Transformer model"
+    "# Training"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8f9ffc79",
+   "metadata": {},
+   "source": [
+    "## Training a simple Transformer model"
    ]
   },
   {
@@ -277,7 +285,7 @@
    "id": "0730f674",
    "metadata": {},
    "source": [
-    "# Training FastBert"
+    "## Training FastBert"
    ]
   },
   {
@@ -428,7 +436,7 @@
    "id": "d24a3a27",
    "metadata": {},
    "source": [
-    "# Training TheseusBert"
+    "## Training TheseusBert"
    ]
   },
   {

docs/tutorials/Training.ipynb

@@ -44,6 +44,7 @@ autodoc-pydantic = "^1.8.0"
 sphinxext-opengraph = "^0.8.2"
 sphinx-copybutton = "^0.5.2"
 myst-parser = "^1.0.0"
+nbsphinx = "^0.9.2"
 
 [tool.poetry.group.dev]
 optional = true