From 9ee4f593beb3df640a6b1befe453b2e5d1f97df2 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Mon, 5 Jun 2023 20:25:35 +0200 Subject: Moving documentation to Mkdocs. --- mkdocs.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 mkdocs.yml (limited to 'mkdocs.yml') 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 -- cgit v1.1