From 2217afd83ec8d35dc9a4494ed470ac4b2309d079 Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Thu, 27 Apr 2023 20:51:24 +0200 Subject: [PATCH] Resolve mkdocstrings deprecations --- docs/api.md | 5 ++--- docs/extras.md | 2 +- mkdocs.yml | 6 ++++-- pyproject.toml | 2 +- 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/api.md b/docs/api.md index dcadaa8..a9e7518 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,13 +1,12 @@ # API ## ::: mkdocs_gen_files - selection: + options: members: false ### ::: mkdocs_gen_files.editor.FilesEditor - selection: + options: filters: ['!', open, config] - rendering: show_root_heading: false ## ::: mkdocs_gen_files.editor.FilesEditor diff --git a/docs/extras.md b/docs/extras.md index 8bdff96..e64bf2e 100644 --- a/docs/extras.md +++ b/docs/extras.md @@ -3,6 +3,6 @@ ### Reference: `mkdocs_gen_files.Nav` #### ::: mkdocs_gen_files.Nav - rendering: + options: show_root_heading: false show_root_toc_entry: false diff --git a/mkdocs.yml b/mkdocs.yml index 50e00dd..35a39e0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,6 +18,9 @@ theme: extra_css: - assets/style.css +watch: + - mkdocs_gen_files + plugins: - search - gen-files: @@ -25,10 +28,9 @@ plugins: - docs/gen_pages.py - literate-nav - mkdocstrings: - watch: [mkdocs_gen_files] handlers: python: - rendering: + options: show_root_heading: true show_signature_annotations: true show_source: false diff --git a/pyproject.toml b/pyproject.toml index 10d8df1..3d6263e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -97,7 +97,7 @@ format = [ [tool.hatch.envs.docs] detached = true dependencies = [ - "mkdocs >=1.1.2", + "mkdocs >=1.3.0", "mkdocs-material >=7.3.6", "mkdocstrings-python >=0.7.1", "mkdocs-gen-files >=0.3.2",