Update poetry and tweak documentation

EdmundGoodman · Apr 24, 2024 · 2ae3b17 · 2ae3b17
1 parent 022081a
commit 2ae3b17
Show file tree

Hide file tree

Showing 6 changed files with 296 additions and 273 deletions.
diff --git a/Makefile b/Makefile
@@ -68,7 +68,10 @@ uml: .venv/
 	@echo "Generating UML diagrams"
 	@cd docs/assets/images/ &&\
 		rm -rf uml && mkdir uml/ && cd uml/ &&\
-		poetry run pyreverse -o png -p hpc-multibench ../../../../src/hpc_multibench
+		poetry run pyreverse \
+			-o png -p hpc-multibench \
+			--ignore plot,tui \
+			../../../../src/hpc_multibench
 
 .PHONY: docs
 docs: .venv/

diff --git a/docs/assets/images/uml/classes_hpc-multibench.png b/docs/assets/images/uml/classes_hpc-multibench.png
diff --git a/docs/assets/images/uml/packages_hpc-multibench.png b/docs/assets/images/uml/packages_hpc-multibench.png
diff --git a/docs/reference/tui.md b/docs/reference/tui.md
@@ -1,3 +1,8 @@
+---
+hide:
+  - toc
+---
+
 # Reference
 
 ::: hpc_multibench.tui.interactive_ui

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -43,7 +43,6 @@ theme:
     #  - navigation.tracking
     - search.highlight
     - search.suggest
-    - toc.follow
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -102,15 +101,14 @@ plugins:
   - mkdocstrings:
       handlers:
         python:
-          selection:
-            filters:
-              - "!UFloat" # Ignore strange type wrapper causing warnings
           options:
             docstring_style: google
             members_order: source
             show_root_heading: true
             show_root_full_path: false
             show_signature_annotations: true
+            filters:
+              - "!UFloat" # Ignore strange type wrapper causing warnings
 
 extra:
   social: