Skip to content

Sort the packages and the modules in the markdown output #340

@pallosp

Description

@pallosp

Is your feature request related to a problem? Please describe.

pydoc-markdown v4.8.2 discovers the modules using docspec_python.discover(path), which returns them in non-deterministic order. This order propagates through the processors and the renderer all the way to the Markdown output.

Describe the solution you'd like

Sort the modules and the packages at loading time.

Describe alternatives you've considered

  • An alternative would be to do the sorting at rendering time. Drawback: it has to be implemented for each renderer.
  • If there is interest, we could support configuring the sorting strategy (e.g. case insensitive, number-aware).

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions