Skip to content

Commit

Permalink
Resolve mkdocstrings deprecations
Browse files Browse the repository at this point in the history
  • Loading branch information
oprypin committed Apr 27, 2023
1 parent 61233e6 commit 2217afd
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
5 changes: 2 additions & 3 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/extras.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
### Reference: `mkdocs_gen_files.Nav`

#### ::: mkdocs_gen_files.Nav
rendering:
options:
show_root_heading: false
show_root_toc_entry: false
6 changes: 4 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,19 @@ theme:
extra_css:
- assets/style.css

watch:
- mkdocs_gen_files

plugins:
- search
- gen-files:
scripts:
- 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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 2217afd

Please sign in to comment.