Add Setup section to README for dev dependencies and doc-builder #41338
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
Add Setup section for installing dev dependencies and doc-builder
|
Hi @gante @zucchini-nlp could you please review this PR when you have a chance? It adds the Setup section to the README for dev dependencies and doc-builder. Thanks! |
zucchini-nlp
reviewed
Oct 6, 2025
Comment on lines
+19
to
+21
| ```bash | ||
| pip install -e ".[dev]" # Installs dev dependencies | ||
| pip install git+https://github.com/huggingface/doc-builder # Installs doc-builder |
There was a problem hiding this comment.
hmm, i think this is a bit redundant as the package installation is detailed in lines 23 and 45 in main branch
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Title:
Add Setup section for installing dev dependencies and doc-builder
Description:
This PR adds a Setup section to docs/README.md that guides contributors on installing the necessary development dependencies and the Hugging Face doc-builder tool. This makes it easier for new contributors to generate and preview documentation locally.
Motivation & Context:
Improves contributor onboarding with clear setup instructions.
Ensures the documentation can be built locally without errors.
Checklist:
Improves documentation.
Follows contributor guidelines.
No new tests are required (documentation-only change).
Who can review:
Any contributor familiar with documentation or the docs setup.
@zucchini-nlp tagging for prioritising review