NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
449 stars 104 forks source link

Sidebar generation does not handle multiple modules with Docusaurus generator #309

Open GirardR1006 opened 6 months ago

GirardR1006 commented 6 months ago

Hello everyone :)

Environment

Describe the bug

When running the Docusaurus generator with multiple packages, the generated sidebar reference only takes one package.

Expected behavior

The generated sidebar reference should take all the specified packages in the config file.

Step to reproduce

  1. Copy the school package in example/src with another name (for instance, school_bis)
  2. In example/docusaurus/pydoc-markdown.yml, add the field packages: [school, school_bis]
  3. Run pydoc-markdown and observe the content of docusaurus-example/docs/reference/sidebar.json: it only contains references to the first package, not the second one. Note that the markdown files are correctly generated, it is only the references that are lacking in the sidebar.