-
-
Notifications
You must be signed in to change notification settings - Fork 123
Description
Is your feature request related to a problem? Please describe.
Easily creating documentation for a large, nested Python package that is easy to browse is difficult.
Describe the solution you'd like
Sphinx has an autodoc in which you can point it to a single top level Python package and it will automatically break that package into a series of nested pages linked together that are easy to browse. This also keeps each individual page from becoming enormous.
The benefits to this is that whenever you refactor your Python code, the docs automatically can be rebuilt without having to mess with any custom RST or Markdown files.
The closest thing I've found with mkdocstrings is to put the top level package into index.md
# My Package
::: my_packageThis solves the refactoring problem, but then the single page is very large and slow to load in the browser.