docs: use jupyterhub_sphinx_theme, add make devenv/linkcheck #8
Conversation
|
should we just move that template repo to the |
|
I am +1 to move that under |
|
@choldgraf yes go for it! I think there is sufficient agreement that this is a good idea at this point with Georgiana's 👍 and others input in jupyterhub/team-compass#524 |
Draft state
|
consideRatio
force-pushed
the
pr/update-docs
branch
from
19ef910
to
3f87a01
Compare
consideRatio
force-pushed
the
pr/update-docs
branch
from
f0e0f8f
to
e6b7674
Compare
|
The jupyterhub-sphinx-theme is in the jupyterhub org, and the opengraph issues are resolved. There is an issue with the favicon, but that would be resolved by jupyterhub/jupyterhub-sphinx-theme#11 independent of this PR. |
| linkcheck: | ||
| $(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)/linkcheck" $(SPHINXOPTS) | ||
| @echo | ||
| @echo "Link check complete; look for any errors in the above output " \ | ||
| "or in $(BUILDDIR)/linkcheck/output.txt." |
There was a problem hiding this comment.
Without this, if you call make linkcheck, it still works, because it matches the first generic target:
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
And it appears to be doing the same thing, i.e. outputs in $(BUILDDIR)/linkcheck/output.txt. Also, the jupyterhub docs Makefile don't have it:
Do we wish to have it here for the extra info echo message? What do you think?
There was a problem hiding this comment.
Sorry I ended up merging before reading this comment, nice catch! Opened #23 about this
There was a problem hiding this comment.
I had a small comment about make linkcheck, but not a blocker.
This looks amazing! Thanks for updating these @consideRatio 🎉
We have discussed use of a jupyterhub_sphinx_theme in jupyterhub/team-compass#524 and @choldgraf has created it. I suggest we start using it!
In this PR I adjust conf.py to look like other jupyterhub projects I've updated recently, linking out to relevant configuration references and omitting some configuration not needed etc.
linkcheckanddevenvcommands to Makefile and make.bat #6jupyterhub-sphinx-themefor all JupyterHub read-the-docs sites team-compass#524 (comment)