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

Any interest in the sphinx-book-theme for docs? #49

Closed
choldgraf opened this issue May 7, 2020 · 5 comments · Fixed by #50
Closed

Any interest in the sphinx-book-theme for docs? #49

choldgraf opened this issue May 7, 2020 · 5 comments · Fixed by #50

Comments

@choldgraf
Copy link
Contributor

We've been working on a simple sphinx theme for the jupyter-book rewrite that I've also found useful for other documentation sites as well (sphinx-book-theme.readthedocs.io)

I find the Alabaster theme to be a little bit cluttered and hard to parse sometimes...would folks be interested in a PR that updates the docs theme for nbclient to the sphinx-book-theme? Here's an example of what it looks like by just swapping the theme name in conf.py:

image

@MSeal
Copy link
Contributor

MSeal commented May 7, 2020

I think that looks nicer. Is there anything unsupported with the new theme or concerns around swapping in the technical sense? @willingc might have some input if we wanted to switch jupyter doc themes or not.

@choldgraf
Copy link
Contributor Author

choldgraf commented May 7, 2020

I think these are the things we'd need to switch:

  • badges to the left that are auto-populated would be moved to the index.rst page rather than auto-generated
  • I can't think of anything else...

We could also customize things etc, that screenshot was just the minimal change to get the theme building with these docs. The sphinx-book-theme is basically a simplified version of the pydata sphinx theme which we've started using across the JupyterHub repositories. I've just been using the sphinx-book-theme for docs that are a bit simpler in nature (e.g. on the order of 3-6 pages without lots of nesting)

@willingc
Copy link
Member

willingc commented May 7, 2020

+1 @choldgraf to dumping alabster for the pydata based book theme. As long at it renders everything fine which it should. Only thought would be to update the sidebar to be a bit more accessible (seems to have low contrast).

@choldgraf
Copy link
Contributor Author

ok - I will make a PR and folks can give their thoughts there. That is a good point about a11y @willingc - currently the navigation bar is low-contrast until the mouse hovers over it (or the focus is on an element inside) and then it becomes high-contrast. I don't think that's ideal for screen readers though :-/

@MSeal
Copy link
Contributor

MSeal commented May 7, 2020

Thanks @choldgraf !

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

Successfully merging a pull request may close this issue.

3 participants