Use `mkdocs-simple`.

[Jordan-Dennis]

Hi all, My main hesitation to making a proper docs page has been that I did not want to add the required docs directory. This package seems to nicely address that. Regards Jordan.

[Jordan-Dennis]

The/One alternative is to use the standard mkdocstrings. I think that mkdocs-semiliterate is the best way to go.

[Jordan-Dennis]

MkAPI is another alternative that also has the ability to inherit docstrings. This one seems a little bit less fleshed out than mkdocs-semiliterate but I would need to do more research.

[Jordan-Dennis]

So it looks like mkdocs-simple interfaces nicely with mkdocstrings. This means that I can combine the power of both to get high quality documentation without the hassle of the docs directory.

[Jordan-Dennis]

I found that mkdocs-simple was enough and that mkdocs-semiliterate was not needed. This is a reminder to remove it from the pyproject.toml.

[Jordan-Dennis]

So I have found a hack that avoids using a docs dir, but I am not a hundred percent satisfied yet. I am trying to use the include_folders option and think that it will be useful in the future, but mkdocs-simple stops treating it as a code directory and does not pass the docstrings from it.

[Jordan-Dennis]

So pytckdocs should have a flag inherited_members: True but I am have not been able to get it to work and have discovered a possible alternative to mkdocs called sphinx.

[Jordan-Dennis]

See this issue for more information.

[Jordan-Dennis]

I am somewhat happy with mkdocs-simple and will use it for now. I may need to abandon it if I cannot sought out the inherited documentation issue though.

[Jordan-Dennis]

I was not using pytkdocs as a backend for mkdocstrings but was instead using griffe.

[Jordan-Dennis]

Wiping and reloading the poetry environment seems to have solved the problem and, we now have inherited documentation :smile:.