Skip to content

Fix instructions for docs dependencies and building#486

Merged
Advueu963 merged 1 commit intommschlk:mainfrom
Zaphoood:fix-docs-install-instructions
Jan 7, 2026
Merged

Fix instructions for docs dependencies and building#486
Advueu963 merged 1 commit intommschlk:mainfrom
Zaphoood:fix-docs-install-instructions

Conversation

@Zaphoood
Copy link
Collaborator

@Zaphoood Zaphoood commented Jan 6, 2026

Motivation and Context

The instructions in CONTRIBUTING.md for installing the dependencies for building the docs and the build command itself were wrong; this PR fixes this.

Regarding the installation command:

  • the --dev flag is unnecessary since the dev dependency group is installed by default
  • the --all-extras is unnecessary since the project doesn't use optional dependencies ('extras'). See docs here

Public API Changes

  • No Public API changes
  • Yes, Public API changes (Details below)

How Has This Been Tested?

I ran the two commands in question locally and verified that they both work.

Checklist

  • The changes have been tested locally.
  • Documentation has been updated (if the public API or usage changes).
  • An entry has been added to CHANGELOG.md (if relevant for users).
  • The code follows the project's style guidelines.
  • I have considered the impact of these changes on the public API.

@Zaphoood Zaphoood self-assigned this Jan 6, 2026
@Zaphoood Zaphoood changed the title docs: fix instructions for docs dependencies and building Fix instructions for docs dependencies and building Jan 6, 2026
@codecov
Copy link

codecov bot commented Jan 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Zaphoood Zaphoood requested review from Advueu963 and mmschlk January 7, 2026 13:01
Copy link
Collaborator

@Advueu963 Advueu963 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing this out! I also do not see that we might need extras in the near future, but maybe @mmschlk has other plans

@Advueu963 Advueu963 merged commit 5ca9860 into mmschlk:main Jan 7, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants