Skip to content

Autodoc-like project layout #389

@johnthagen

Description

@johnthagen

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_package

This solves the refactoring problem, but then the single page is very large and slow to load in the browser.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions