Add custom Sphinx ext - substitute common values in docs

jupyterhub / the-littlest-jupyterhub

Simple JupyterHub distribution for 1-100 users on a single server

https://tljh.jupyter.org

BSD 3-Clause "New" or "Revised" License

1.03k stars 339 forks source link

Add custom Sphinx ext - substitute common values in docs #803

Closed iameskild closed 11 months ago

iameskild commented 2 years ago

[x] Add / update documentation
[ ] Add tests
- Not added, unsure how to test Sphinx extensions.

This is an attempt to reduce the number of places certain values in the docs need to be update, i.e. supported Ubuntu versions. Currently I have only updates the references in a few places.

This Sphinx extension mechanism can be used for other values that need updating on a regular basis.

Closes #720.

welcome[bot] commented 2 years ago

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly. welcome You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! :wave:
Welcome to the Jupyter community! :tada:

yuvipanda commented 11 months ago

Sorry for the really late response, @iameskild! I think leaving them as is is clearer and better, rather than trying to centralize it - makes it slightly harder to read. I'm going to close this one out.

Again, apologies for the super delayed response here.