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

bug: Some section headers are not visible #115

Closed
pawamoy opened this issue Nov 21, 2023 Discussed in #114 · 1 comment
Closed

bug: Some section headers are not visible #115

pawamoy opened this issue Nov 21, 2023 Discussed in #114 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@pawamoy
Copy link
Member

pawamoy commented Nov 21, 2023

Discussed in #114

Originally posted by zerojun-wows November 18, 2023
I am trying to use mkdocstrings 0.24.0 with the readthedocs-theme.

But in that mkdoocstrings page some section headers are missing.

My configuration:
mkdocs.yml.txt

Page to display mkdocstrings generated content:
part-argparse.md
screenshot:
Webaufnahme_18-11-2023_2360_127 0 0 1

Notes section has a heading as can be seen. The Examples section has no heading.
Parameters and Returns sections also look strange.

I don't know what I could have done wrong and somehow I couldn't find anything in the documentation.

Maybe someone here knows what could help in this case?

@pawamoy pawamoy added the bug Something isn't working label Nov 21, 2023
@pawamoy pawamoy self-assigned this Nov 21, 2023
@pawamoy
Copy link
Member Author

pawamoy commented Nov 21, 2023

After investigating #114:

  • Turns out the language files for readthedocs only contain the sentences used by readthedocs templates, but not by the fallback material ones. So for example, the docstring examples fall back to the material template which uses section.title or lang.t("Examples:"), which does not appear in the readthedocs language file.
  • "Notes" are rendered with a level 4 heading: that is expected, and will be fixed once the Numpy parser supports admonitions, see feat: numpy admonitions griffe#219

I'll fix the first point and close 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant