Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
GirardR1006 opened this issue Jan 5, 2024 · 0 comments
Assignees

Comments

@GirardR1006
Copy link

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants