Merge pull request #314 from kayjan/feature/mkdoc-jupyter

Mkdocs with jupyter notebook

CHANGELOG.md

@@ -5,8 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [0.22.1] - 2024-11-03
 ### Added:
-- (WIP) Misc: Documentation to rely on jupyter notebook.
+- Misc: Documentation to rely on jupyter notebook.
 ### Changed:
 - Tree Export: Exporting to dot allow node_attr and edge_attr to modify node before retrieving node name.
 - Misc: All code reference to node_name (immutable) instead of name (mutable).
@@ -677,7 +679,8 @@ ignore null attribute columns.
 - Utility Iterator: Tree traversal methods.
 - Workflow To Do App: Tree use case with to-do list implementation.
 
-[Unreleased]: https://github.com/kayjan/bigtree/compare/0.22.0...HEAD
+[Unreleased]: https://github.com/kayjan/bigtree/compare/0.22.1...HEAD
+[0.22.1]: https://github.com/kayjan/bigtree/compare/0.22.0...0.22.1
 [0.22.0]: https://github.com/kayjan/bigtree/compare/0.21.3...0.22.0
 [0.21.3]: https://github.com/kayjan/bigtree/compare/0.21.2...0.21.3
 [0.21.2]: https://github.com/kayjan/bigtree/compare/0.21.1...0.21.2

bigtree/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.22.0"
+__version__ = "0.22.1"
 
 from bigtree.binarytree.construct import list_to_binarytree
 from bigtree.dag.construct import dataframe_to_dag, dict_to_dag, list_to_dag

docs/gettingstarted/demo/workflow.ipynb → docs/gettingstarted/demo/Workflow Demonstration.ipynb

@@ -52,7 +52,11 @@
     "\n",
     "app = AppToDo(\"To Do App\")\n",
     "app.add_item(item_name=\"Homework 1\", list_name=\"School\")\n",
-    "app.add_item(item_name=[\"Milk\", \"Bread\"], list_name=\"Groceries\", description=\"Urgent\")\n",
+    "app.add_item(\n",
+    "    item_name=[\"Milk\", \"Bread\"],\n",
+    "    list_name=\"Groceries\",\n",
+    "    description=\"Urgent\",\n",
+    ")\n",
     "app.add_item(item_name=\"Cook\")\n",
     "app.show()"
    ]
@@ -103,7 +107,12 @@
     "\n",
     "calendar = Calendar(\"My Calendar\")\n",
     "calendar.add_event(\"Gym\", \"2023-01-01 18:00\")\n",
-    "calendar.add_event(\"Dinner\", \"2023-01-01\", date_format=\"%Y-%m-%d\", budget=20)\n",
+    "calendar.add_event(\n",
+    "    \"Dinner\",\n",
+    "    \"2023-01-01\",\n",
+    "    date_format=\"%Y-%m-%d\",\n",
+    "    budget=20,\n",
+    ")\n",
     "calendar.add_event(\"Gym\", \"2023-01-02 18:00\")\n",
     "calendar.show()"
    ]

mkdocs.yml

@@ -23,7 +23,7 @@ nav:
       - gettingstarted/demo/tree.md
       - gettingstarted/demo/binarytree.md
       - gettingstarted/demo/dag.md
-      - gettingstarted/demo/workflow.md
+      - gettingstarted/demo/Workflow Demonstration.ipynb
     - Resources:
       - gettingstarted/resources/articles.md
       - gettingstarted/resources/glossary.md
@@ -94,7 +94,7 @@ theme:
 plugins:
   - glightbox  # expand images
   - mkdocs-jupyter:
-      include_source: True
+      ignore_h1_titles: True
   - search
   - social:
       cards_layout_options: