Skip to content

Commit

Permalink
Fix inherited_members (#801)
Browse files Browse the repository at this point in the history
* show_inherited_members is not a valid option
* Merge options and selection. from mkdocstrings.github.io: "Since
mkdocstrings 0.19, the YAML selection key is merged into the options
key."
  * We are using `mkdocstrings-0.23` in rtd builds

**Pull Request Checklist**
- [x] Fixes #774 
- [x] [Good commit messages](https://cbea.ms/git-commit/) and/or PR
title

**Description of PR**
Currently, subclasses don't show inherited members. This option was
intended to be turned on but the name was wrong.

Signed-off-by: Elliot Gunton <egunton@bloomberg.net>
  • Loading branch information
elliotgunton authored Oct 6, 2023
1 parent c8cbf0c commit 15914a1
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,11 +118,10 @@ plugins:
options:
# show_category_heading: true
show_if_no_docstring: true
show_inherited_members: true
inherited_members: true
filters: ["!^_.*$"]
show_bases: false
separate_signature: true
selection:
docstring_style: google
rendering:
show_source: true
Expand Down

0 comments on commit 15914a1

Please sign in to comment.