8000 bug: TOC is displaying full path names for attributes after upgrading from 1.16.8 to 1.16.10 · Issue #271 · mkdocstrings/python · GitHub
[go: up one dir, main page]
Skip to content

bug: TOC is displaying full path names for attributes after upgrading from 1.16.8 to 1.16.10 #271

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.

Sign up for GitHub

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

Jump to bottom
Closed
davlee1972 opened this issue Apr 10, 2025 · 3 comments
Closed

bug: TOC is displaying full path names for attributes after upgrading from 1.16.8 to 1.16.10 #271

davlee1972 opened this issue Apr 10, 2025 · 3 comments
Assignees
@pawamoy
Labels
bug Something isn't working

Comments

@davlee1972
Copy link
Contributor

Description of the bug

Table of Contents is displaying full path names for attributes after upgrading from 1.16.8 to 1.16.10.

Before package upgrade from 1.16.8

Image

After package upgrade to 1.16.10

Image

To Reproduce

Upgrading mkdocstrings-python from 1.16.8 to 1.16.10 broke the TOC
Installing collected packages: mkdocstrings-python
Attempting uninstall: mkdocstrings-python
Found existing installation: mkdocstrings-python 1.16.8
Uninstalling mkdocstrings-python-1.16.8:
Successfully uninstalled mkdocstrings-python-1.16.8
Successfully installed mkdocstrings-python-1.16.10

Downgrading mkdocstrings-python from 1.16.10 to 1.16.8 fixed the TOC
Installing collected packages: mkdocstrings-python
Attempting uninstall: mkdocstrings-python
Found existing installation: mkdocstrings-python 1.16.10
Uninstalling mkdocstrings-python-1.16.10:
Successfully uninstalled mkdocstrings-python-1.16.10
Successfully installed mkdocstrings-python-1.16.8
@davlee1972 davlee1972 added the unconfirmed This bug was not reproduced yet label Apr 10, 2025
@davlee1972
Copy link
Contributor Author
davlee1972 commented Apr 11, 2025 •
edited
Loading

Created a pull request to fix this.. version 1.16.9 typo swapped attribute.name with attribute_name in the toc jinja.

Pull Request: #272

@davlee1972 davlee1972 mentioned this issue Apr 11, 2025
Merged
@pawamoy
Copy link
Member
pawamoy commented Apr 14, 2025

Thank you for the report and PR @davlee1972! 🚀 The PR looks good, I'll likely add regression tests to it very soon 🙂

@pawamoy pawamoy added bug Something isn't working and removed unconfirmed This bug was not reproduced yet labels Apr 14, 2025
@pawamoy
Copy link
Member
pawamoy commented May 20, 2025

Turns out the theme is responsible for rendering the ToC, and our test suite isn't prepared for that, so I'll just merge as-is for now 🙂 Thanks again!

pawamoy pushed a commit that referenced this issue May 20, 2025
@davlee1972
fix: Render attribute names without full path in ToC
d4e618a 
Issue-271: #271
PR-272: #272
@pawamoy pawamoy closed this as completed May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pawamoy pawamoy

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pawamoy @davlee1972
0