refactor docs a little

CERTCC · Sep 29, 2023 · 95ec303 · 95ec303
1 parent f908c6e
commit 95ec303
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 8 deletions.
diff --git a/docs/reference/code/case_states.md b/docs/reference/code/case_states.md
@@ -1,7 +1,11 @@
+# Vultron Case States Module
+
 ::: vultron.case_states
 
-::: vultron.case_states.errors
+::: vultron.case_states.hypercube
 
 ::: vultron.case_states.states
 
-::: vultron.case_states.validations
+::: vultron.case_states.validations
+
+::: vultron.case_states.errors
diff --git a/docs/reference/code/cs_model.md b/docs/reference/code/cs_model.md
diff --git a/docs/reference/code/index.md b/docs/reference/code/index.md
@@ -1,8 +1,10 @@
+# Vultron Modules
+
 ::: vultron
 
-## Packages:
-- ::: vultron.cvd_states
+::: vultron.case_states
+
+See [Case States](case_states.md) for more information.
 
-## Submodules:
-- ::: vultron.errors
+::: vultron.errors
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -126,7 +126,6 @@ nav:
       - VFDPXA: 'reference/case_states/state__v__f__d__p__x__a_.md'
     - Code:
         - vultron: 'reference/code/index.md'
-        - cs_model: 'reference/code/cs_model.md'
         - case_states: 'reference/code/case_states.md'
     - ISO Crosswalk:
       - Introduction: 'reference/iso_crosswalk.md'
@@ -172,6 +171,10 @@ plugins:
       handlers:
         python:
           paths: [ 'src' ]
+          options:
+            show_bases: true
+            show_root_heading: true
+            heading_level: 2
   - search
 repo_url: 'https://github.com/CERTCC/Vultron'
 repo_name: 'CERTCC/Vultron'