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
docs: add devenv and linkcheck to Makefile and misc details #1565
Conversation
b16a8c5
to
87d2dfb
Compare
49c9557
to
8f378d5
Compare
7e23b0a
to
a8ca73a
Compare
9a65773
to
886d65e
Compare
886d65e
to
c4ed19f
Compare
With documentation in plain markdown and as built myst-markdown we got warnings about the links referencing section headers by name in myst. Like this, we ensure that the built documentation works great instead of compromising on that and getting warnings about it when building the documentation.
c4ed19f
to
b3bdd15
Compare
jupyterhub/binderhub#1565 Merge pull request #1565 from consideRatio/pr/docs-maintenance
Merging, since it's good to have these. But linkcheck's not run on CI, is it? Should that be a new workflow? Or is there a way to run linkcheck on RTD only on PRs (because real docs builds shouldn't be prevented if a link breaks)? |
I think having linkcheck in the ci system for push and prs is too much noise overall, having a weekly/monthly run via schedule and a badge for failing or not in the project readme could make sense i think. |
Related