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

Latest KubeSpawner API docs are broken #685

Closed
manics opened this issue Dec 4, 2022 · 2 comments · Fixed by #687
Closed

Latest KubeSpawner API docs are broken #685

manics opened this issue Dec 4, 2022 · 2 comments · Fixed by #687
Labels

Comments

@manics
Copy link
Member

manics commented Dec 4, 2022

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 #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

@manics manics added the bug label Dec 4, 2022
@manics manics changed the title KubeSpawner API docs are broken Latest KubeSpawner API docs are broken Dec 4, 2022
@consideRatio
Copy link
Member

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

Related

@manics
Copy link
Member Author

manics commented Dec 6, 2022

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

consideRatio added a commit to consideRatio/kubespawner that referenced this issue Dec 6, 2022
For details on why this has to be reverted, see
jupyterhub#685 (comment).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants