aboutsummaryrefslogtreecommitdiff
path: root/mkdocs.yml
diff options
context:
space:
mode:
authorThéo de la Hogue2023-06-06 17:46:49 +0200
committerThéo de la Hogue2023-06-06 17:46:49 +0200
commit8352274b19ae10cecbdb87f96606bc28157427c8 (patch)
tree919d144421e7479990a7e357bbd57ee0aadd3a83 /mkdocs.yml
parentb109578ec1e8635aeb9f12c3a913108232347935 (diff)
downloadargaze-8352274b19ae10cecbdb87f96606bc28157427c8.zip
argaze-8352274b19ae10cecbdb87f96606bc28157427c8.tar.gz
argaze-8352274b19ae10cecbdb87f96606bc28157427c8.tar.bz2
argaze-8352274b19ae10cecbdb87f96606bc28157427c8.tar.xz
Working on documentation architecture.
Diffstat (limited to 'mkdocs.yml')
-rw-r--r--mkdocs.yml15
1 files changed, 13 insertions, 2 deletions
diff --git a/mkdocs.yml b/mkdocs.yml
index 685f62e..98b3557 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,15 +1,25 @@
site_name: ArGaze documentation
nav:
- index.md
-- getting_started.md
+- Getting Started:
+ - getting_started/installation.md
+ - getting_started/ready-made.md
+ - getting_started/demos.md
- Code Reference:
- - argaze.md
+ - argaze.md
+- Contributor's Guide:
+ - contributor_guide/build_documentation.md
+ - contributor_guide/unitary_test.md
theme:
name: readthedocs
+ palette:
+ primary: #0299D2
extra_css:
- css/extra.css
plugins:
- search
+ - autorefs
+ - include-markdown
- mkdocstrings:
handlers:
# See: https://mkdocstrings.github.io/python/usage/
@@ -28,4 +38,5 @@ watch:
markdown_extensions:
- markdown_include.include:
base_path: .
+ - attr_list
- admonition