Refresh docs/conf.py and rtd/noxfile conf #12
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
consideRatio
commented
Sep 18, 2023
- Update gitignore
- Add inline comment about theme.conf
- Fix reqiurements for RTD and nox configs, remove docs/requirements.txt
- docs: modernize docs/conf.py
consideRatio
commented
Sep 18, 2023
Comment on lines
-21
to
-22
| extra_requirements: | ||
| - docs |
There was a problem hiding this comment.
We nad no such extra requirements
consideRatio
commented
Sep 18, 2023
Comment on lines
-1
to
-2
| myst-parser | ||
| IPython # For debugging |
There was a problem hiding this comment.
I figure the docs should test the jupyterhub_sphinx_theme's dependencies directly, but as installing a package in the parent folder is a bit messy I figured this is removed and that we let the RTD config / noxfile config install the package itself directly without referencing this file.
consideRatio
commented
Sep 18, 2023
Comment on lines
-30
to
-32
| html_title = "JupyterHub Sphinx Theme" | ||
| html_copy_source = True | ||
| html_sourcelink_suffix = "" |
There was a problem hiding this comment.
We don't set these things in other sphinx conf.py files, so I figure we shouldn't here either.
html_titlegets a value anyhow from the rendered pageshtml_copy_sourceis defaulting to True anyhowhtml_sourcelink_suffixcould possibly be relevant to set explicitly to override the default of.txt, but I don't know when and why so I'm assuming this is just a copy/paste legacy config of no purpose for this projects function
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.