-
Notifications
You must be signed in to change notification settings - Fork 87
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
Use readthedocs? #128
Comments
I always use https://nbgitpuller.link ;) |
Would links break? IIRC that's why we didn't do it last time, and that's why I bought nbgitpuller.link... |
oh yeah, I forgot about that URL! ah pre-existing links you mean...maybe. I guess we could set up sphinx re-directs? How many links to the docs are there out there? |
I've got no objections. Though
is slightly concerning- if you have to remember it instead of clicking on a link somewhere obvious does that mean it's not prominent enough? |
I think my perspective would be reflective of "somebody that uses readthedocs a lot, and knows that nbgitpuller exists, but doesn't have the docs URL memorized". So I default to assuming a project docs are at |
Is there a decision here? Do people want to move to RTD (and it's a matter of finding time to do it) or is everyone happy with the current URLs? |
I'm a fan of readthedocs :-) |
If it helps you can setup redirects in RTD instead of doing it in Sphinx https://docs.readthedocs.io/en/stable/user-defined-redirects.html#prefix-redirects |
we've also used this in the jupyter book project which has worked well: https://github.com/wpilibsuite/sphinxext-rediraffe |
As long as the current URL for nbgitpuller link generator continues to work, I'm happy for this to be wherever :) |
Maybe this is just me being whiny, but I find it difficult to remember the URL of this repository since it's a sub-domain of the jupyterhub
github.io
page. I'd findnbgitpuller.readthedocs.io
easier to remember, since it follows the same pattern that many other orgs do. Withjupyterhub.github.io/nbgitpuller
I have to remember things like "is nbgitpuller injupyter/
orjupyterhub/
". Would anybody be opposed to using RTD for the docs?The text was updated successfully, but these errors were encountered: