bug: ensure sphinx build works #130
Open
Conversation
This file contains hidden or 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
|
Thank goodness for the tests here - they caught my mistake! |
lwasser
commented
Nov 1, 2025
| @@ -1,17 +1,3 @@ | |||
| {% if documentation == "mkdocs" -%} | |||
There was a problem hiding this comment.
Rather than having dependencies defined differently - i think we should always just use optional.dependency groups. and call them in hatch - that simplifies a lot!
lwasser
commented
Nov 1, 2025
| {%- endif %} | ||
| ] | ||
|
|
||
| docs = [ |
There was a problem hiding this comment.
That way - this section doesn't change if we use hatch envs or not!
lwasser
commented
Nov 1, 2025
| "Sphinx ~=8.0", | ||
| "sphinx-autobuild ==2024.10.3" | ||
| # Install optional dependency test for docs | ||
| features = [ |
There was a problem hiding this comment.
This is how you call optional deps in a hatch envt!
lwasser
commented
Nov 1, 2025
| - pip install --upgrade pip setuptools wheel | ||
| - pip install hatch | ||
| {%- if documentation == "mkdocs" %} | ||
| - pip install --upgrade pip |
|
Looks like something isn't running on python 3.10. open to any suggestions as the tests run locally! |
|
I might actually understand this ... seems like sphinx 8.2 isn't supported by python 3.10 so... back to 8.0 we go.. thank you diffs for helping my pea brain figure this out. 🤞🏻 it works. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This pr closes #126 . It fixes
✅ rtd configuration needed a few tweaks
✅ move dependency groups to
optional.dependencies. This offers more flexibility and also allows us to migrate more easily if needed to another tool in the future, as this is standard practice for packages.✅ then we call the deps as a feature element in the hatch envt!
it seems to work really well.
I tested this config over in pyosPackage and it works great. I opened #129 because we will need to test this with mkdocs as well. I am not sure that trying to add flags to a
hatch run docs:buildcommand works (i could be wrong!!). I just couldn't get it to work.