Finish switch to tree views as library

mcbookshelf · Dec 21, 2024 · 3e2d591 · 3e2d591
1 parent ba5f9bc
commit 3e2d591
Show file tree

Hide file tree

Showing 27 changed files with 45 additions and 139 deletions.
diff --git a/docs/_static/icons/dir/audio.svg b/docs/_static/icons/dir/audio.svg
diff --git a/docs/_static/icons/dir/folder.svg b/docs/_static/icons/dir/folder.svg
diff --git a/docs/_static/icons/dir/image.svg b/docs/_static/icons/dir/image.svg
diff --git a/docs/_static/icons/dir/json.svg b/docs/_static/icons/dir/json.svg
diff --git a/docs/_static/icons/dir/mcfunction.svg b/docs/_static/icons/dir/mcfunction.svg
diff --git a/docs/_static/icons/dir/mcmeta.svg b/docs/_static/icons/dir/mcmeta.svg
diff --git a/docs/_static/icons/dir/nbt.svg b/docs/_static/icons/dir/nbt.svg
diff --git a/docs/_static/icons/dir/yml.svg b/docs/_static/icons/dir/yml.svg
diff --git a/docs/_static/icons/nbt/any.svg b/docs/_static/icons/nbt/any.svg
diff --git a/docs/_static/icons/nbt/bool.svg b/docs/_static/icons/nbt/bool.svg
diff --git a/docs/_static/icons/nbt/byte-array.svg b/docs/_static/icons/nbt/byte-array.svg
diff --git a/docs/_static/icons/nbt/byte.svg b/docs/_static/icons/nbt/byte.svg
diff --git a/docs/_static/icons/nbt/compound.svg b/docs/_static/icons/nbt/compound.svg
diff --git a/docs/_static/icons/nbt/double.svg b/docs/_static/icons/nbt/double.svg
diff --git a/docs/_static/icons/nbt/float.svg b/docs/_static/icons/nbt/float.svg
diff --git a/docs/_static/icons/nbt/int-array.svg b/docs/_static/icons/nbt/int-array.svg
diff --git a/docs/_static/icons/nbt/int.svg b/docs/_static/icons/nbt/int.svg
diff --git a/docs/_static/icons/nbt/list.svg b/docs/_static/icons/nbt/list.svg
diff --git a/docs/_static/icons/nbt/long-array.svg b/docs/_static/icons/nbt/long-array.svg
diff --git a/docs/_static/icons/nbt/long.svg b/docs/_static/icons/nbt/long.svg
diff --git a/docs/_static/icons/nbt/number.svg b/docs/_static/icons/nbt/number.svg
diff --git a/docs/_static/icons/nbt/short.svg b/docs/_static/icons/nbt/short.svg
diff --git a/docs/_static/icons/nbt/string.svg b/docs/_static/icons/nbt/string.svg
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,7 +1,5 @@
 import os
 
-from sphinx_treeview import DecoratorType, imagesToDecoratorIcons
-
 # -- Project information -----------------------------------------------------
 
 project = "Bookshelf"
@@ -14,11 +12,11 @@
 extensions = [
     "myst_parser",
     "sphinx_copybutton",
+    "sphinx_copybutton",
     "sphinx_design",
+    "sphinx_minecraft",
     "sphinx_togglebutton",
     "sphinx_treeview",
-    "sphinx_copybutton",
-    "sphinx_minecraft",
 ]
 
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
@@ -44,20 +42,6 @@
     "tasklist",
 ]
 
-# -- TreeView options  -------------------------------------------------------
-
-stv_disable_default_decorators = True
-stv_decorators = [
-    DecoratorType(
-        name="dir",
-        icons=imagesToDecoratorIcons("_static/icons/dir", "icons/dir"),
-    ),
-    DecoratorType(
-        name="nbt",
-        icons=imagesToDecoratorIcons("_static/icons/nbt", "icons/nbt"),
-    ),
-]
-
 # -- Options for HTML output -------------------------------------------------
 
 html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")

diff --git a/docs/contribute/tree-structure.md b/docs/contribute/tree-structure.md
@@ -10,7 +10,7 @@ Bookshelf respects a certain tree structure which can be similar to Java package
 
 :::::{grid} 1 2 2 2
 ::::{grid-item}
-:columns: 12 6 7 7
+:columns: 12 6 6 6
 
 **Module Requirements:**
 
@@ -27,31 +27,31 @@ Bookshelf respects a certain tree structure which can be similar to Java package
 
 - A feature is equal to a unique utility, so we should not hesitate to decompose its features in order to make it more readable and to promote reusability.
 
-In addition to these few constraints, the Bookshelf contributor is free to organise their files as they wishes as long as it remains coherent, understandable and it respects the global structure.
+In addition to these few constraints, contributors are free to organize their files as they wish as long as it remains coherent and it respects the global structure.
 ::::
 ::::{grid-item}
-:columns: 12 6 5 5
+:columns: 12 6 6 6
 
 :::{treeview}
-- {dir}`folder` modules
-  - {dir}`folder` \<module\>
-    - {dir}`folder` data/\<module\>
-      - {dir}`folder` function
-        - {dir}`folder` \<feature1\>
-          - {dir}`mcfunction` \<feature1\>.mcfunction
-          - {dir}`mcfunction` ...
-        - {dir}`mcfunction` \<feature2\>.mcfunction
-        - {dir}`mcfunction` \_\_load\_\_.mcfunction
-        - {dir}`mcfunction` \_\_unload\_\_.mcfunction
-      - {dir}`folder` \<predicate|loot_table|...\>
-        - {dir}`json` \<feature1\>.json
-        - {dir}`json` ...
-      - {dir}`folder` tags
-        - {dir}`folder` function
-          - {dir}`json` \<feature1\>.json
-          - {dir}`json` ...
-    - {dir}`json` module.json
-  - {dir}`folder` ...
+- {mcdir}`folder` modules
+  - {mcdir}`folder` \<module\>
+    - {mcdir}`folder` data/\<module\>
+      - {mcdir}`folder` function
+        - {mcdir}`folder` \<feature1\>
+          - {mcdir}`mcfunction` \<feature1\>.mcfunction
+          - {mcdir}`mcfunction` ...
+        - {mcdir}`mcfunction` \<feature2\>.mcfunction
+        - {mcdir}`mcfunction` \_\_load\_\_.mcfunction
+        - {mcdir}`mcfunction` \_\_unload\_\_.mcfunction
+      - {mcdir}`folder` \<predicate|loot_table|...\>
+        - {mcdir}`json` \<feature1\>.json
+        - {mcdir}`json` ...
+      - {mcdir}`folder` tags
+        - {mcdir}`folder` function
+          - {mcdir}`json` \<feature1\>.json
+          - {mcdir}`json` ...
+    - {mcdir}`json` module.json
+  - {mcdir}`folder` ...
 :::
 ::::
 :::::
diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,10 +33,10 @@ docs = [
   "sphinx-autobuild>=2024.10.3",
   "sphinx-copybutton>=0.5.2",
   "sphinx-design>=0.6.1",
+  "sphinx-minecraft>=1.0.0",
   "sphinx-togglebutton>=0.3.2",
-  "sphinx-treeview>=0.1.3",
+  "sphinx-treeview>=1.0.0",
   "sphinx>=8.1.3",
-  "sphinx-minecraft>=1.0.0",
 ]
 
 [project.scripts]