-
Notifications
You must be signed in to change notification settings - Fork 33
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
Create a jupyterhub-sphinx-theme
for all JupyterHub read-the-docs sites
#524
Comments
Hey all - I finally had a moment to give this a shot! I have a working "JupyterHub Sphinx Theme" at this repository:
It makes a few choices about colors, icons, etc but is otherwise totally customizable on top of it. If we ever wanted to change something in the documentation that propagated to all jupyterhub docs at the same time, we could just change it in this theme. What do folks think?If people think this would be useful, I am happy to move that repo into this organization and then start activating it for a few of our repositories to see how it goes. |
How about we add this to https://github.com/jupyterhub/jupyterhub-python-repo-template ? |
👍 for making the jupyterhub-sphinx-theme a jupyterhub github org project and updating our python template project to rely on it! |
I've proposed that https://github.com/jupyterhub/jupyterhub-python-repo-template starts relying on this theme now in jupyterhub/jupyterhub-python-repo-template#8, where @choldgraf suggested we make a move from choldgraf/ to jupyterhub/. I suggested we go for it now, WDYT - OK to relocate choldgraf/jupyterhub-sphinx-theme to jupyterhub org? |
Theme is now in the
|
Testing on JupyterHub: jupyterhub/jupyterhub#4363 . Looks great so far! |
If we're going ahead with recommending this org wide how about we open a docs PR somewhere to document the use of this, and close this issue? |
Indeed - I think that the action to close this is:
|
Proposed change
Create a new Python package
jupyterhub-sphinx-theme
that includes a set of default Sphinx themes and plugins, and some configuration that can be applied across all JupyterHub read-the-docs sites.Alternative options
Do nothing
Who would use this feature?
Everyone editing documentation on JupyterHub RTD projects.
(Optional): Suggest a solution
This was suggested by @choldgraf as part of some exploratory work on adding opengraph tags in jupyterhub/zero-to-jupyterhub-k8s#2717 and pydata/pydata-sphinx-theme#664
We could start by iterating on https://github.com/jupyterhub/zero-to-jupyterhub-k8s , then when we've got a stable configuration think about making it into a package?
If
jupyterhub-sphinx-theme
pins all dependencies exactly we can then leave the theme unpinned in all JupyterHub projects, and manage updates in one place.The text was updated successfully, but these errors were encountered: