search

jupyterhub / kubespawner

Kubernetes spawner for JupyterHub
https://jupyterhub-kubespawner.readthedocs.io
BSD 3-Clause "New" or "Revised" License
536 stars 301 forks source link

Documentation Missing #370

Closed Robert-Carver closed 4 years ago

Robert-Carver commented 4 years ago

The documentation pages for:

consideRatio commented 4 years ago

Thanks for reporting this @Robert-Carver! :heart:

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 https://github.com/jupyterhub/kubespawner/issues/366 about kubernetes==11.0.01b is broke.

consideRatio commented 4 years ago

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: https://github.com/pypa/setuptools/issues/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?