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 theme to pandas sphinx #816

Merged
merged 4 commits into from Nov 28, 2019
Merged

updating theme to pandas sphinx #816

merged 4 commits into from Nov 28, 2019

Conversation

@choldgraf
Copy link
Collaborator

choldgraf commented Nov 26, 2019

This updates the theme to the new pandas sphinx theme, it adds a few extra pages, but it does not change the URLs of any pre-existing pages.

@choldgraf choldgraf force-pushed the choldgraf:theme branch from 5355f4f to 3115a37 Nov 27, 2019
@choldgraf

This comment has been minimized.

Copy link
Collaborator Author

choldgraf commented Nov 27, 2019

Hmmm I'm not sure why CircleCI is not showing up here, has anyone else noticed docs builds not happening on repo2docker?

(also, it seemed like the error with the earlier build was on the stencila-r job, it was a hang which makes me think it's unrelated to this PR)

@betatim

This comment has been minimized.

Copy link
Member

betatim commented Nov 27, 2019

I've not paid attention to the circleci build, so not sure if has been broken for a while or not :( Now it is only the code coverage check that fails (maybe something to investigate because changing the docs shouldn't change the coverage -> for a new issue though).

No idea why circleci doesn't run :(

@betatim

This comment has been minimized.

Copy link
Member

betatim commented Nov 27, 2019

Maybe because you are pushing to branches in this repo (which I think we shouldn't do :) ) instead of having your branch in your fork? In travis you can configure things to only run for PRs but not pushes, maybe CircleCI has a similar feature?

@choldgraf

This comment has been minimized.

Copy link
Collaborator Author

choldgraf commented Nov 27, 2019

re: pushing to branches, I'm a bit confused by what you mean. Isn't my branch attached to my org? (https://github.com/choldgraf/repo2docker/tree/theme)

re: code coverage....yeah I'm not sure what to do about this since none of these changes are touching code (outside of the docs) or tests 🤔

@betatim

This comment has been minimized.

Copy link
Member

betatim commented Nov 27, 2019

Apologies, I didn't look properly: it looked like you pushed a branch to this repo instead of your fork. Then I am officially out of ideas as to why CircleCI doesn't get triggered. It did run for a PR a few days ago so I will close and re-open this PR to see what that does.

@betatim betatim closed this Nov 27, 2019
@betatim betatim reopened this Nov 27, 2019
@choldgraf

This comment has been minimized.

Copy link
Collaborator Author

choldgraf commented Nov 27, 2019

ok weird, I just opened up a new PR here: #817 with a dummy commit and it does trigger circleci throws up hands

I also tried opening up a new PR from my repo and it also didn't work. So:

  • PR on a branch from jupyter/ repo: ✔️
  • PR from @choldgraf's branch:

Anybody else wanna try opening a quick PR from their branch to see if this works?

@betatim

This comment has been minimized.

Copy link
Member

betatim commented Nov 27, 2019

#820 triggered a build. Have you looked at the settings of your repo2docker project for CircleCI? I am 80% sure that your personal settings/fork settings don't influence stuff here but you never know. This situation should already not be happening :-/

@choldgraf

This comment has been minimized.

Copy link
Collaborator Author

choldgraf commented Nov 27, 2019

ah hah, I think I figured it out. Somehow circleci had started building my repo2docker fork on top of the jupyter/repo2docker one. And so I think what happened is that it was treating the jupyter repo2docker PRs as "redundant" and not building them.

Here are the docs:

https://861-90722372-gh.circle-artifacts.com/0/html/index.html

Now we can get to actually critiquing this PR haha

@betatim

This comment has been minimized.

Copy link
Member

betatim commented Nov 27, 2019

I think it looks good.

One thing that is weird is that some of the headings are "links". For example if you go to https://861-90722372-gh.circle-artifacts.com/0/html/config_files.html#environment-yml-install-a-python-environment that heading is styled like a link. But other headings like https://861-90722372-gh.circle-artifacts.com/0/html/howto/user_interface.html#nteract aren't. Figuring out how we can get both to not be styled like a hyperlink would be cool.

The other thing I checked is use http://khan.github.io/tota11y/ on the new docs. It has a few complaints about contrast. Is this something we can upstream? It even makes suggestions for other colours to use that have enough contrast so it could be an easy set of changes.

@choldgraf

This comment has been minimized.

Copy link
Collaborator Author

choldgraf commented Nov 27, 2019

Ah - I believe that's actually because of the contents:: directive on the page, which was causing all of the headers to be rendered as links. I just removed it, since it's redundant with the sidebar to the right, and the headings now look normal. Does that work?

re: a11y and upstreaming, we can definitely improve upon this. I've been upstreaming a bunch of stuff to https://github.com/pandas-dev/pandas-sphinx-theme already, and I think the general plan is to eventually move this out of the pandas-dev org and into pydata, and call it something like sphinx-pydata.

I also opened up an issue about a11y here: pandas-dev/pandas-sphinx-theme#61

@consideRatio

This comment has been minimized.

Copy link
Collaborator

consideRatio commented Nov 28, 2019

I did a git pull to z2jh recently to update my local master branch, and found this summary of relocated files etc. Concusion, git can be helpful to track this!

51 files changed, 194 insertions(+), 123 deletions(-)
 rename doc/source/{ => administrator}/advanced.md (100%)
 rename doc/source/{ => administrator}/architecture.rst (91%)
 rename doc/source/{ => administrator}/authentication.rst (100%)
 rename doc/source/{ => administrator}/cost.rst (100%)
 rename doc/source/{ => administrator}/debug.rst (100%)
 create mode 100644 doc/source/administrator/index.rst
 rename doc/source/{ => administrator}/optimization.md (100%)
 rename doc/source/{ => administrator}/security.md (94%)
 rename doc/source/{ => administrator}/troubleshooting.rst (100%)
 rename doc/source/{ => administrator}/upgrading.md (100%)
 rename doc/source/{ => community}/additional-resources.rst (100%)
 create mode 100644 doc/source/community/index.rst
 rename doc/source/{ => community}/tips.rst (100%)
 rename doc/source/{ => community}/users-list.md (100%)
 rename doc/source/{ => customizing}/extending-jupyterhub.rst (100%)
 create mode 100644 doc/source/customizing/index.rst
 rename doc/source/{ => customizing}/user-environment.rst (100%)
 rename doc/source/{ => customizing}/user-management.md (97%)
 rename doc/source/{ => customizing}/user-resources.rst (100%)
 rename doc/source/{ => customizing}/user-storage.md (100%)
 delete mode 100644 doc/source/getting-started.rst
 rename doc/source/{ => reference}/glossary.rst (100%)
 create mode 100644 doc/source/reference/index.rst
 rename doc/source/{ => reference}/reference-docs.rst (100%)
 rename doc/source/{ => reference}/reference.txt (100%)
 rename doc/source/{ => reference}/tools.rst (100%)
 create mode 100644 doc/source/setup-jupyterhub/index.rst
 rename doc/source/{ => setup-jupyterhub}/setup-helm.rst (100%)
 rename doc/source/{ => setup-jupyterhub}/setup-jupyterhub.rst (100%)
 rename doc/source/{ => setup-jupyterhub}/turn-off.rst (100%)
@betatim betatim merged commit 3337eaa into jupyter:master Nov 28, 2019
20 checks passed
20 checks passed
ci/circleci: build_docs Your tests passed on CircleCI!
Details
ci/dockercloud Your tests passed in Docker Cloud
Details
codecov/patch Coverage not affected when comparing 242107b...51e26fb
Details
codecov/project 90.94% remains the same compared to 242107b
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
default Workflow: default
Details
jupyter.repo2docker #20191127.10 succeeded
Details
jupyter.repo2docker (Job base) Job base succeeded
Details
jupyter.repo2docker (Job conda) Job conda succeeded
Details
jupyter.repo2docker (Job dockerfile) Job dockerfile succeeded
Details
jupyter.repo2docker (Job external) Job external succeeded
Details
jupyter.repo2docker (Job julia) Job julia succeeded
Details
jupyter.repo2docker (Job lint) Job lint succeeded
Details
jupyter.repo2docker (Job nix) Job nix succeeded
Details
jupyter.repo2docker (Job pipfile) Job pipfile succeeded
Details
jupyter.repo2docker (Job r) Job r succeeded
Details
jupyter.repo2docker (Job stencila_py) Job stencila_py succeeded
Details
jupyter.repo2docker (Job stencila_r) Job stencila_r succeeded
Details
jupyter.repo2docker (Job unit) Job unit succeeded
Details
jupyter.repo2docker (Job venv) Job venv succeeded
Details
@betatim

This comment has been minimized.

Copy link
Member

betatim commented Nov 28, 2019

Merged! We can address the "linkified headers" in a new PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.