-
-
Notifications
You must be signed in to change notification settings - Fork 109
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
Labels
unconfirmed
This bug was not reproduced yet
Comments
oprypin
added a commit
to mkdocstrings/crystal
that referenced
this issue
Dec 8, 2020
For myself I fixed it in mkdocstrings/crystal@d621b12
|
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 🙂 |
oprypin
added a commit
to oprypin/mkdocstrings
that referenced
this issue
Dec 12, 2020
pawamoy
pushed a commit
to oprypin/mkdocstrings
that referenced
this issue
Dec 16, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 currentheading_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.
The text was updated successfully, but these errors were encountered: