Updated docs

dhondta · May 24, 2023 · 2f1a89a · 2f1a89a
1 parent fba866c
commit 2f1a89a
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -8,14 +8,14 @@ nav:
   - 'Getting started': quickstart.md
   - Design: design.md
   - Classes:
-    - classes.md
+    - classes/index.md
     - Entity: classes/entity.md
     - Console: classes/console.md
     - Command: classes/command.md
     - Module: classes/module.md
     - Datastore: classes/datastore.md
   - 'Base entities':
-    - base.md
+    - base/index.md
     - Consoles: base/consoles.md
     - Commands: base/commands.md
     - Models: base/models.md
@@ -49,6 +49,8 @@ theme:
         name: Switch to light mode
   features:
     - navigation.indexes
+    - navigation.top
+    - toc.integrate
   logo: img/logo.png
   favicon: img/icon.png
 use_directory_urls: false

diff --git a/docs/pages/base.md b/docs/pages/base.md
diff --git a/docs/pages/base/index.md b/docs/pages/base/index.md
@@ -0,0 +1 @@
+This section presents the entities provided with Sploitkit.
diff --git a/docs/pages/classes.md → docs/pages/classes/index.md b/docs/pages/classes.md → docs/pages/classes/index.md
@@ -1,5 +1,5 @@
 The following figure depicts the class hierarchy implementing the aforementioned design :
 
-![Sploitkit - Class hierarchy](img/class-hierarchy.png)
+<img src="../img/class-hierarchy.png" alt="Sploitkit - Class hierarchy">
 
 On this figure, one can see the main attributes and methods that can be used (in black) or overridden (in red).
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,6 +1,6 @@
 jinja2<3.1.0
 mkdocs>=1.3.0
 mkdocs-bootswatch
-mkdocs-material
+mkdocs-material>=7.3.0
 mkdocs-rtd-dropdown
 pymdown-extensions