-
Notifications
You must be signed in to change notification settings - Fork 25
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
Formatting of readers in docs #73
Comments
Yes, that docstring looks messy. Maybe a grayish color? |
Bit hard to read, what about black? Also, why is the "optional" not pink anymore? I also wonder if the theme we're using supports a dark mode, do you know? |
Regarding the colors, maybe function/class names should stay pink and monospaced text should be black? But this is probably not possible I assume. |
Black is better readable, yes! Dark mode looks like a no(t yet) The 'optional' changed together with the inline code, I couldn't find an option to prevent this in the default theme.css :/ We could switch to furo, which has a dark mode and displays inline code similar to GitHub. It doesn't have a menu bar at the top though: |
No objection, if you don't mind the missing top navbar I'd say let's do it! I assume the GitHub icon and the RTD version switcher still works? |
ad navbar: I think it's fine, I'd just put 'API' last as its the only element with a dropdown ad GitHub: no, but the link could be in the left navigation bar (example) ad version switcher: that should be part of RTD, so nothing to worry here |
Fixed in #74. |
Should the readers in the first column on https://sleepecg.readthedocs.io/en/stable/datasets.html get formatted as code (i.e. enclosed in backticks)?
The text was updated successfully, but these errors were encountered: