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

Documentation request - document how to override CSS elements #48

Closed
couling opened this issue Jan 13, 2023 · 1 comment
Closed

Documentation request - document how to override CSS elements #48

couling opened this issue Jan 13, 2023 · 1 comment
Labels
docs Improvements or additions to documentation

Comments

@couling
Copy link

couling commented Jan 13, 2023

Looking here: https://mkdocstrings.github.io/python/customization/ it describes the CSS classes which are used with mkdocstrings-python. Unfortunelty some of us are coming into this cold and so it's much less obvious how to customise them. Despite giving example CSS rules for Material and ReadTheDocs, there's no hint of where to copy-paste this code to.

I understand the basic principle of CSS and HTML, but have no idea about the architecture that would allow me to add additional CSS files.

Would it be possible to document how to override CSS elements (on the page linked above) or otherwise cross link the relevant documentation (say on Mkdocs?). At minimum, it would be helpful if those code examples for themes could be completed with instructions on what to do with them.


I'm hitting this because I personally find the grey styled code headings very distracting. All features other than the background are fine, but the grey box is tripping my eye into missing that it's a heading.

@pawamoy
Copy link
Member

pawamoy commented Jan 15, 2023

Thanks for the feedback, this is always appreciated 🙂
I'll label this as "docs improvements" for when I have time!

@pawamoy pawamoy added the docs Improvements or additions to documentation label Jan 15, 2023
pawamoy added a commit that referenced this issue Apr 12, 2024
@pawamoy pawamoy closed this as completed Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants