diff options
author | Théo de la Hogue | 2023-06-05 20:25:35 +0200 |
---|---|---|
committer | Théo de la Hogue | 2023-06-05 20:25:35 +0200 |
commit | 9ee4f593beb3df640a6b1befe453b2e5d1f97df2 (patch) | |
tree | 6648eceb599e52f991817916dd02a6cb29a5210f /mkdocs.yml | |
parent | 1a44012e1cebcec41f2a43b926da30e6d904ed1f (diff) | |
download | argaze-9ee4f593beb3df640a6b1befe453b2e5d1f97df2.zip argaze-9ee4f593beb3df640a6b1befe453b2e5d1f97df2.tar.gz argaze-9ee4f593beb3df640a6b1befe453b2e5d1f97df2.tar.bz2 argaze-9ee4f593beb3df640a6b1befe453b2e5d1f97df2.tar.xz |
Moving documentation to Mkdocs.
Diffstat (limited to 'mkdocs.yml')
-rw-r--r-- | mkdocs.yml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c954ec8 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,25 @@ +site_name: ArGaze documentation +theme: + name: readthedocs + highlightjs: true +plugins: + - search + - mkdocstrings: + handlers: + # See: https://mkdocstrings.github.io/python/usage/ + python: + options: + docstring_style: google + allow_inspection: false + show_source: false + members_order: 'alphabetical' + heading_level: 2 + annotations_path: brief + show_submodules: true + show_root_toc_entry: false + watch: + - src/argaze +markdown_extensions: + - markdown_include.include: + base_path: . + - admonition |