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

Autodoc generated documentation overflow for python classes with a long import path #1631

Open
federicodabrunzo opened this issue Nov 19, 2024 · 0 comments
Labels
Bug A bug Needed: replication Bug replication is required

Comments

@federicodabrunzo
Copy link

Problem

The documentation generated with the autoclass directive for python classes placed in a module with a long import path overflows the wy-nav-content div.

Reproducible Project

https://github.com/federicodabrunzo/render-issue-for-autodoc-generated-class-with-long-import-path/tree/main?tab=readme-ov-file

Error Logs/Results

image

Expected Results

The <dt> element containing the class import path should not overflow its containing elements.

Environment Info

  • Python Version: 3.11.9
  • Sphinx Version: 8.1.3
  • RTD Theme Version: 3.0.1
@federicodabrunzo federicodabrunzo added Bug A bug Needed: replication Bug replication is required labels Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug Needed: replication Bug replication is required
Projects
None yet
Development

No branches or pull requests

1 participant