-
Notifications
You must be signed in to change notification settings - Fork 2k
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
updating to pandas docs theme #2820
Conversation
e8b6471
to
f64de76
Compare
ok, I think this is ready to go (Travis might need to be fixed). What do folks think? |
@choldgraf - stealing your attention here! Can you make me RTD maintainer on kubespawner? |
I just added descriptions to each index page, as well as including EOLs to try and make travis happy. @consideRatio : done! |
The documentation looks great! This LGTM! |
Does anybody know what this error in travis (under the "lint" job) means?
|
https://github.com/jupyterhub/jupyterhub/blob/master/.pre-commit-config.yaml, it is about: "requirements-txt-fixer - Sorts entries in requirements.txt and removes incorrect entry for pkg-resources==0.0.0" |
I saw that there, but I wasn't sure what the problem was. Does it mean that we can't pin to a non-versioned dependency for the docs? |
I don't know, I'd try to install this pre-commit fix thing locally to run it locally and see what comes of it. I failed to install it last time i tried =/ |
yeah I still haven't figured out how to install the pre-commit thing locally either :-( |
ok I think figured out both how to install the pre-commit thing (I guess it was doing some weird stuff with WSL) and also fixed the error that was popping up |
I agree - I am happy to hold off merging to make sure others are happy with the changes I don't believe that any pages have moved here, so there shouldn't be any broken links (only new ones). As an aside, a quick way to get a list of moved files is to search for the " |
e884d6a
to
644d2d2
Compare
644d2d2
to
e44ee6e
Compare
Rebased to fix the merge conflict, and so we can preview our nifty Institutional FAQ with the new theme :-) https://1663-20785986-gh.circle-artifacts.com/0/html/getting-started/institutional-faq.html |
@choldgraf Use your judgement. I'm swamped at the moment. I'm sure it's an improvement. Go for it. |
IMO these are good to go if folks agree that the general theme structure is good, and I'm happy to available to spot-check things that we missed etc if something comes up. |
Yay! |
This updates the documentation theme to
pandas_sphinx_theme
. It does not rearrange any pages, because we've already done a great job of organizing much of the documentation for this repo :-)So the difference should only be cosmetic, not structural. One thing I did do was re-organize a few of the
toctree
pieces so that we have fewer "top-level" sections in the docs. Let's take a look at how this looks in the built docs to see if we like it.Current docs: https://jupyterhub.readthedocs.io/en/latest/
New docs: https://1626-20785986-gh.circle-artifacts.com/0/html/index.html