Skip to content

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

@GirardR1006

Description

@GirardR1006

Hello everyone :)

Environment

  • Pydoc-Markdown Version: v4.5.0
  • Python Version: v3.10.13
  • Operating System: Linux (Ubuntu 22.04 LTS)

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.

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions