Documentation updates (#28)

.github/workflows/docs.yml

@@ -51,8 +51,19 @@ jobs:
       - name: Install dependencies
         run: poetry install
 
+      - name: Glob notebooks in docs folder
+        uses: tj-actions/glob@v22
+        id: glob
+        with:
+          files: |
+            docs/**/*.ipynb
+
+      - name: Run documentation notebooks
+        run: |
+          poetry run jupyter nbconvert --execute --to notebook --inplace ${{ steps.glob.outputs.paths }}
+
       - name: Generate docs
-        working-directory: doc/
+        working-directory: docs/
         run: make html
 
       - name: Setup Pages
@@ -61,7 +72,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: "doc/_build/html/"
+          path: "docs/_build/html/"
 
       - name: Deploy to GitHub Pages
         id: deployment

README.md

@@ -1,5 +1,9 @@
 # stormvogel 🐦
 
+An interactive approach to probabilistic model checking
+
+Take a look at [the stormvogel documentation!](https://moves-rwth.github.io/stormvogel/)
+
 ## Setup
 
 Install `poetry`. Install dependencies:

doc/conf.py → docs/conf.py

@@ -24,5 +24,5 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "alabaster"
+html_theme = "furo"
 html_static_path = ["_static"]

doc/die.ipynb → docs/getting_started/die.ipynb

@@ -10,7 +10,14 @@
     {
       "cell_type": "code",
       "execution_count": 1,
-      "metadata": {},
+      "metadata": {
+        "execution": {
+          "iopub.execute_input": "2024-07-09T08:20:25.882261Z",
+          "iopub.status.busy": "2024-07-09T08:20:25.882010Z",
+          "iopub.status.idle": "2024-07-09T08:20:26.004272Z",
+          "shell.execute_reply": "2024-07-09T08:20:26.004022Z"
+        }
+      },
       "outputs": [],
       "source": [
         "import stormvogel.model\n",
@@ -28,6 +35,12 @@
       "cell_type": "code",
       "execution_count": 2,
       "metadata": {
+        "execution": {
+          "iopub.execute_input": "2024-07-09T08:20:26.005831Z",
+          "iopub.status.busy": "2024-07-09T08:20:26.005718Z",
+          "iopub.status.idle": "2024-07-09T08:20:26.016517Z",
+          "shell.execute_reply": "2024-07-09T08:20:26.016314Z"
+        },
         "scrolled": true
       },
       "outputs": [
@@ -334,7 +347,7 @@
               "                  // adding nodes and edges to the graph\n",
               "                  data = {nodes: nodes, edges: edges};\n",
               "\n",
-              "                  var options = {"nodes": {"color": {"background": "white", "border": "black", "highlight": {"background": "white", "border": "black"}}}, "init": {"borderWidth": 3, "color": null, "shape": "circle"}, "states": {"borderWidth": 1, "color": null, "shape": "elipse"}, "actions": {"borderWidth": 1, "color": null, "shape": "box"}, "numbers": {"fractions": true, "digits": 5, "max_denominator": 20}, "layout": {"randomSeed": 5}};\n",
+              "                  var options = {"nodes": {"color": {"background": "white", "border": "black", "highlight": {"background": "white", "border": "black"}, "font": {"color": "black", "size": 14}}}, "init": {"borderWidth": 3, "color": null, "shape": "circle", "repulsion": 1}, "states": {"borderWidth": 1, "color": null, "shape": "elipse", "repulsion": 1}, "actions": {"borderWidth": 1, "color": null, "shape": "box", "repulsion": 1}, "numbers": {"fractions": true, "digits": 5, "max_denominator": 20}, "edges": {"font": {"color": "black", "size": 14}}, "layout": {"randomSeed": 5}};\n",
               "\n",
               "                  \n",
               "\n",
@@ -373,7 +386,7 @@
         {
           "data": {
             "text/plain": [
-              "<stormvogel.visualization.Visualization at 0x108b41160>"
+              "<stormvogel.visualization.Visualization at 0x1044b8b00>"
             ]
           },
           "execution_count": 2,