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

Markdown headings can bust to the topmost nav level #192

Closed
oprypin opened this issue Dec 7, 2020 · 2 comments
Closed

Markdown headings can bust to the topmost nav level #192

oprypin opened this issue Dec 7, 2020 · 2 comments
Labels

Comments

@oprypin
Copy link
Member

@oprypin oprypin commented Dec 7, 2020

I'm actually not entirely sure if it's the case for Python renderer, but in my own renderer I ran into the issue that if the docstring contains a # Markdown Heading, it's not adjusted according to the current heading_level, so in the nav it'll just appear as a topmost item regardless of what's happening around it.

I'm currently looking into a solution.

@oprypin oprypin added the unconfirmed label Dec 7, 2020
oprypin added a commit to mkdocstrings/crystal that referenced this issue Dec 8, 2020
@oprypin
Copy link
Member Author

@oprypin oprypin commented Dec 8, 2020

For myself I fixed it in mkdocstrings/crystal@d621b12

Before After
Before After
@pawamoy
Copy link
Member

@pawamoy pawamoy commented Dec 8, 2020

It certainly behaves the same for the Python renderer. I didn't think about using headings in docstrings myself. I'd say it's more a lack of a feature than a bug 🙂
If you want to send a PR with your fix @oprypin, I'll accept it!

oprypin added a commit to oprypin/mkdocstrings that referenced this issue Dec 12, 2020
pawamoy added a commit to oprypin/mkdocstrings that referenced this issue Dec 16, 2020
@pawamoy pawamoy closed this in #195 Dec 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants