From 95ec3035a26d75ecc9242ccacc06e8d76dba5260 Mon Sep 17 00:00:00 2001 From: "Allen D. Householder" Date: Fri, 29 Sep 2023 13:28:39 -0400 Subject: [PATCH] refactor docs a little --- docs/reference/code/case_states.md | 8 ++++++-- docs/reference/code/cs_model.md | 1 - docs/reference/code/index.md | 10 ++++++---- mkdocs.yml | 5 ++++- 4 files changed, 16 insertions(+), 8 deletions(-) delete mode 100644 docs/reference/code/cs_model.md diff --git a/docs/reference/code/case_states.md b/docs/reference/code/case_states.md index fd155049..6b445161 100644 --- 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 \ No newline at end of file +::: vultron.case_states.validations + +::: vultron.case_states.errors diff --git a/docs/reference/code/cs_model.md b/docs/reference/code/cs_model.md deleted file mode 100644 index a9fcb0d8..00000000 --- a/docs/reference/code/cs_model.md +++ /dev/null @@ -1 +0,0 @@ -::: vultron.cvd_states.hypercube diff --git a/docs/reference/code/index.md b/docs/reference/code/index.md index 9476d109..38fa9a3d 100644 --- 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 index 4bcaf511..808feba7 100644 --- 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'