jupyterhub / kubespawner

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

Latest KubeSpawner API docs are broken #685

Closed manics closed 1 year ago

manics commented 1 year ago

Bug description

https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html#kubespawner.KubeSpawner.events_enabled (referenced from https://z2jh.jupyter.org/en/stable/resources/reference.html#singleuser-events) should link to the API documentation for KubeSpawner.events_enabled. It doesn't.

Expected behaviour

The 4.3.0 version works https://jupyterhub-kubespawner.readthedocs.io/en/4.3.0/spawner.html#kubespawner.KubeSpawner.events_enabled so this probably originates from rst2myst in https://github.com/jupyterhub/kubespawner/pull/684

Actual behaviour

It's currently broken, there's just .. py:module:: kubespawner text: image

How to reproduce

https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html

Your personal set up

N/A

consideRatio commented 1 year ago

This sparked a lot of additional thinking and working from my side :)

Related

manics commented 1 year ago

Thanks..... I'd naively hoped it was a simple fix 😢