Update docs building instructions in readme #66
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
shamrin
requested changes
Dec 9, 2025
| cd docs | ||
| make html | ||
| uv pip install -r requirements.txt | ||
| uv run make html |
Collaborator
There was a problem hiding this comment.
Can we move these to top-level pyproject.toml, using separate docs dependency group?
Author
There was a problem hiding this comment.
Pushed the change. TBH I prefer putting that all into one group (not dev + docs like now); uv sync --group dev after installing docs deps removes the docs dependencies. You need to do uv sync --all-groups or uv sync --group docs --group dev to keep both.
Author
There was a problem hiding this comment.
This also applies the suggestions I made to another MR #65
So if this one is merged, the other one can be closed.
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.
No description provided.