Fix instructions for docs dependencies and building#486
Merged
Advueu963 merged 1 commit intommschlk:mainfrom Jan 7, 2026
Merged
Fix instructions for docs dependencies and building#486Advueu963 merged 1 commit intommschlk:mainfrom
Advueu963 merged 1 commit intommschlk:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
Motivation and Context
The instructions in
CONTRIBUTING.mdfor installing the dependencies for building the docs and the build command itself were wrong; this PR fixes this.Regarding the installation command:
--devflag is unnecessary since thedevdependency group is installed by default--all-extrasis unnecessary since the project doesn't use optional dependencies ('extras'). See docs herePublic API Changes
How Has This Been Tested?
I ran the two commands in question locally and verified that they both work.
Checklist
CHANGELOG.md(if relevant for users).