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

updating to pandas docs theme #2820

Merged
merged 7 commits into from
Dec 3, 2019
Merged

Conversation

choldgraf
Copy link
Member

@choldgraf choldgraf commented Nov 15, 2019

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

@choldgraf choldgraf force-pushed the docs_theme branch 13 times, most recently from e8b6471 to f64de76 Compare November 15, 2019 04:35
@choldgraf choldgraf changed the title [WIP] updating to pandas docs theme updating to pandas docs theme Nov 15, 2019
@choldgraf
Copy link
Member Author

ok, I think this is ready to go (Travis might need to be fixed). What do folks think?

@consideRatio
Copy link
Member

consideRatio commented Nov 19, 2019

@choldgraf - stealing your attention here! Can you make me RTD maintainer on kubespawner?

https://readthedocs.org/projects/jupyterhub-kubespawner

@choldgraf
Copy link
Member Author

I just added descriptions to each index page, as well as including EOLs to try and make travis happy.

@consideRatio : done!

@consideRatio
Copy link
Member

The documentation looks great! This LGTM!

@choldgraf
Copy link
Member Author

Does anybody know what this error in travis (under the "lint" job) means?

Fix requirements.txt.....................................................Failed

@consideRatio
Copy link
Member

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"

@consideRatio
Copy link
Member

@choldgraf
Copy link
Member Author

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?

@consideRatio
Copy link
Member

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 =/

@choldgraf
Copy link
Member Author

choldgraf commented Nov 19, 2019

yeah I still haven't figured out how to install the pre-commit thing locally either :-(

@choldgraf
Copy link
Member Author

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

@betatim
Copy link
Member

betatim commented Nov 20, 2019

I like the new layout.

Two things before we merge:

  • @minrk and @willingc you should give your 👍 before we do this
  • my usual question: which external links do we break with this move?

@choldgraf
Copy link
Member Author

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 "" character in the "files changed" page - that should find all the files that were renamed or moved

@choldgraf
Copy link
Member Author

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

@willingc
Copy link
Contributor

@choldgraf Use your judgement. I'm swamped at the moment. I'm sure it's an improvement. Go for it.

@choldgraf
Copy link
Member Author

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.

@minrk minrk merged commit 4e8acc7 into jupyterhub:master Dec 3, 2019
@minrk
Copy link
Member

minrk commented Dec 3, 2019

Yay!

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 this pull request may close these issues.

5 participants