From a4e1c6dcf48669de1c298bbc12203c94dc91e488 Mon Sep 17 00:00:00 2001 From: Sam Morley-Short Date: Fri, 3 May 2024 12:14:07 +0100 Subject: [PATCH] docs: update reference API docs --- docs/reference.md | 20 -------------------- mkdocs.yml | 12 +++++++++++- 2 files changed, 11 insertions(+), 21 deletions(-) diff --git a/docs/reference.md b/docs/reference.md index c0745a7..479de21 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,31 +1,11 @@ # API reference ::: bartiq - handler: python - options: - show_source: false - -::: bartiq.compilation - handler: python - options: - show_source: false ::: bartiq.precompilation - handler: python - options: - show_source: false ::: bartiq.symbolics - handler: python - options: - show_source: false ::: bartiq.routing - handler: python - options: - show_source: false ::: bartiq.errors - handler: python - options: - show_source: false diff --git a/mkdocs.yml b/mkdocs.yml index 9697876..6ba7591 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,7 +33,17 @@ plugins: - link-marker - open-in-new-tab - search - - mkdocstrings + - mkdocstrings: + default_handler: python + handlers: + python: + options: + show_source: false + separate_signature: true + line_length: 60 + modernize_annotations: true + show_signature_annotations: true + show_root_heading: true - mkdocs-jupyter: include_source: True