Skip to content

Add Setup section to README for dev dependencies and doc-builder #41338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add Setup section to README for dev dependencies and doc-builder #41338

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b01d0b
Update README.md
Karthikg998 Oct 4, 2025
915f6f7
Merge branch 'main' into docs-fix-bert
Karthikg998 Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ See the License for the specific language governing permissions and
limitations under the License.
-->

# Setup

```bash
pip install -e ".[dev]" # Installs dev dependencies
pip install git+https://github.com/huggingface/doc-builder # Installs doc-builder
Comment on lines +19 to +21
Copy link
Member

@zucchini-nlp zucchini-nlp Oct 6, 2025

Choose a reason for hiding this comment

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

hmm, i think this is a bit redundant as the package installation is detailed in lines 23 and 45 in main branch


```

# Generating the documentation

To generate the documentation, you first have to build it. Several packages are necessary to build the doc,
Expand Down