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

fixing broken links #1823

Merged
merged 1 commit into from
Oct 7, 2020
Merged

Conversation

choldgraf
Copy link
Member

@choldgraf choldgraf commented Oct 7, 2020

This fixes some broken links that we were manually hardcoding to specific headers on the reference page. Instead we are now programmatically adding Sphinx labels to each section of that page so that we can reference them in a URL-agnostic way.

The new Sphinx labels have the structure:

schema:<object>

For example,

schema:scheduling.podPriority

So you can refer to them directly like Here is my sentence and now I :ref:`refer to pod priority in rST <schema:scheduling.podPriority>` .

closes #1717

@consideRatio
Copy link
Member

consideRatio commented Oct 7, 2020

Wieee and it works :D Thank you @choldgraf !!! 🎉 ❤️ 🌻

@consideRatio consideRatio merged commit 1a3ee39 into jupyterhub:master Oct 7, 2020
@choldgraf
Copy link
Member Author

oh btw - I also ran make linkcheck on the docs and only found one other broken link, so I think that we should be OK now?

@consideRatio
Copy link
Member

checking consistency... /home/travis/build/jupyterhub/zero-to-jupyterhub-k8s/doc/source/reference.md: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] setup-jupyterhub/turn-off                              
/home/travis/build/jupyterhub/zero-to-jupyterhub-k8s/doc/source/reference.md:1: WARNING: Pygments lexer name 'eval_rst' is not known
/home/travis/build/jupyterhub/zero-to-jupyterhub-k8s/doc/source/reference.md:16: WARNING: Pygments lexer name 'eval_rst' is not known

Ah well... these are open issues still :§ A lot of trouble coming from the generated section :<

@choldgraf
Copy link
Member Author

choldgraf commented Oct 7, 2020

I think we should be able to remove reference.md, no? It seems like it's just a static version of the programmatically-created one that lives at reference/reference.md, no?

That'd also remove the eval_rst errors, which are carryovers from when we used recommonmark

@consideRatio
Copy link
Member

Oh! I didn't realize it's that file: #1822

Yeah, I can go ahead and remove it. I'm feeling a bit vane and will do it by committing in another name to not be associated with that amount of line deletions introduced by mistake :p

@choldgraf
Copy link
Member Author

lol :-)

@consideRatio
Copy link
Member

Yepp haha i lolled too realizing this ;D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken link in user placeholder docs
2 participants