Closed Jordan-Dennis closed 1 year ago
Hello, thanks for the report. I think you're not using pytkdocs but Griffe, because that's what mkdocstrings-python
uses. If you want to use pytkdocs, which is the only one supporting inherited members yet, you have to use mkdocstrings-python-legacy
(or mkdocstrings[python-legacy]
, same thing).
Thanks @pawamoy,
I have tried to use this but I am now getting the following error,
Running poetry show | grep "docs"
I get the following list
The content of my mkdocs.yml
is,
Regards
Jordan
Could you try to remove then recreate your Poetry-managed virtualenv?
Yep that worked. Thank you.
Describe the bug I am using
mkdocs-simple-plugin
,mkdocstrings[python]
andpytkdocs
to generate documentation. I am extending another package that I worked on (i.e. the parent class is not in the project) but I cannot get the super class methods to render in the docs withinherited_members: True
.To Reproduce This is my construction in the same file (
mkdocs-simple
) as the class.where both insert and remove are methods of the parent class.
Expected behavior I expect the documentation for
insert
andremove
to be visible when I runmkdocs serve
System (please complete the following information):
pytkdocs==0.16.2
python==3.10.8
mkdocstrings==0.19.1
mkdocstrings-python==0.8.3
mkdocs-simple-plugin==2.1.2