From 99582e5747b34d7f03a3bc377ee14d5f4447e47d Mon Sep 17 00:00:00 2001 From: javierzazo_microsoft Date: Thu, 29 Aug 2024 16:08:54 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=90=9B=20fix:=20add=20missing=20plugin=20?= =?UTF-8?q?to=20mkdocs.yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/reference.md.jinja | 2 +- ...ocumentation %}mkdocs.yml{% endif %}.jinja | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/reference.md.jinja b/docs/reference.md.jinja index d5bfa58..852f52b 100644 --- a/docs/reference.md.jinja +++ b/docs/reference.md.jinja @@ -1,3 +1,3 @@ -# :books: API reference +# :books: reference ::: {{ module_name }} diff --git a/template/{% if documentation %}mkdocs.yml{% endif %}.jinja b/template/{% if documentation %}mkdocs.yml{% endif %}.jinja index f4bdf86..9ba1f5b 100644 --- a/template/{% if documentation %}mkdocs.yml{% endif %}.jinja +++ b/template/{% if documentation %}mkdocs.yml{% endif %}.jinja @@ -50,6 +50,25 @@ extra_css: # - js/tex-mml-chtml.js plugins: - search + - mkdocstrings: + default_handler: python + handlers: + python: + paths: [src] + options: + show_inheritance_diagram: true + show_if_no_docstring: true + show_symbol_type_toc: true + show_symbol_type_heading: true + show_signature_annotations: true + show_submodules: true + show_source: true + group_by_category: false + show_category_heading: true + docstring_options: + ignore_init_summary: false + merge_init_into_class: true + separate_signature: true - awesome-pages - mkdocs-video: is_video: true