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.

Sign up for GitHub

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

Jump to bottom

Documentation Missing #370

Closed
Robert-Carver opened this issue Nov 18, 2019 · 2 comments · Fixed by #371
Closed

Documentation Missing #370

Robert-Carver opened this issue Nov 18, 2019 · 2 comments · Fixed by #371

Comments

@Robert-Carver
Copy link

The documentation pages for:

  • "KubeSpawner"
  • "Objects"
  • "Reflectors"
  • "Custom Traitlets"
  • "Utilities"
    Have mysteriously vanished.
@consideRatio
Copy link
Member

consideRatio commented Nov 19, 2019 •
edited
Loading

Thanks for reporting this @Robert-Carver! ❤️

Here is a link to verify that they have indeed vanished: https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html

Here is the latest read the docs build, which is passing: https://readthedocs.org/projects/jupyterhub-kubespawner/builds/9980877/

I recall this happened before, I don't remember why... But, I bet it relates to #366 about kubernetes==11.0.01b is broke.

@consideRatio
Copy link
Member

consideRatio commented Nov 19, 2019 •
edited
Loading

AHA!

It is because read the docs generate this documentation by first installing kubespawner, but unlike pip install -r requirements.txt, installing with python setup.py install will install the requirements with pre-releases included: pypa/setuptools#855

This makes the install succeed, but when we use it kubespawner will fail as it installed a broken pre-release. What we need to do is ensure we don't install the pre-releases. One way to go, is to first run pip install -r requirements.txt. I'll try that.

Ping @choldgraf @willingc, can you let me be a RTD maintainer of kubespawner to configure the build?

@consideRatio consideRatio mentioned this issue Nov 19, 2019
Merged
consideRatio added a commit to consideRatio/fairing that referenced this issue Nov 21, 2019
@consideRatio
Test PyPI pre-releases but allow for failures
a6f8a0c 
Using `python setup.py install` will install PyPI pre-releases of
packages while `pip install -r requirements.txt` won't do that. This
lead to CI tests failing as reported in kubeflow#421. This commit updates the CI
build setup to run two parallell tests, one where we don't use
pre-releases and one where we do but allow them to fail and won't wait
on the run to complete either.

ref: jupyterhub/kubespawner#370 (comment)
Fixes kubeflow#421
@consideRatio consideRatio mentioned this issue Nov 21, 2019
Merged
k8s-ci-robot pushed a commit to kubeflow/fairing that referenced this issue Nov 21, 2019
@consideRatio @k8s-ci-robot
Test PyPI pre-releases but allow for failures (#423)
fd86fc7 
Using `python setup.py install` will install PyPI pre-releases of
packages while `pip install -r requirements.txt` won't do that. This
lead to CI tests failing as reported in #421. This commit updates the CI
build setup to run two parallell tests, one where we don't use
pre-releases and one where we do but allow them to fail and won't wait
on the run to complete either.

ref: jupyterhub/kubespawner#370 (comment)
Fixes #421
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix docs build consideRatio/kubespawner
2 participants
@consideRatio @Robert-Carver