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

Formatting of readers in docs #73

Closed
cbrnr opened this issue Jan 20, 2022 · 9 comments
Closed

Formatting of readers in docs #73

cbrnr opened this issue Jan 20, 2022 · 9 comments

Comments

@cbrnr
Copy link
Owner

cbrnr commented Jan 20, 2022

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)?

@hofaflo
Copy link
Collaborator

hofaflo commented Jan 20, 2022

Good question, the monospaced font would be nice but I'm not so sure about the color 😅

image

Now that I think about it, we could select a less striking color for inline code to avoid things like this:

image

@cbrnr
Copy link
Owner Author

cbrnr commented Jan 20, 2022

Yes, that docstring looks messy. Maybe a grayish color?

@hofaflo
Copy link
Collaborator

hofaflo commented Jan 21, 2022

Like this?
image

@cbrnr
Copy link
Owner Author

cbrnr commented Jan 21, 2022

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?

@cbrnr
Copy link
Owner Author

cbrnr commented Jan 21, 2022

Regarding the colors, maybe function/class names should stay pink and monospaced text should be black? But this is probably not possible I assume.

@hofaflo
Copy link
Collaborator

hofaflo commented Jan 21, 2022

Black is better readable, yes!
image

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:
image
image

@cbrnr
Copy link
Owner Author

cbrnr commented Jan 21, 2022

We could switch to furo

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?

@hofaflo
Copy link
Collaborator

hofaflo commented Jan 21, 2022

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

@cbrnr
Copy link
Owner Author

cbrnr commented Jan 22, 2022

Fixed in #74.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants