Skip to content
Open
Changes from all commits
Commits
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
11 changes: 4 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,10 @@ To generate the documentation, you first have to build it. Several packages are
you can install them with the following command, at the root of the code repository:

```bash
pip install --no-cache-dir --upgrade pip
pip install -e ".[docs]"
```

Then you need to install our open source documentation builder tool:

```bash
pip install git+https://github.com/huggingface/doc-builder
```

---
**NOTE**

Expand Down Expand Up @@ -57,13 +52,15 @@ For example:
doc-builder preview diffusers docs/source/en
```

The docs will be viewable at [http://localhost:3000](http://localhost:3000). You can also preview the docs once you have opened a PR. You will see a bot add a comment to a link where the documentation with your changes lives.
The docs will be viewable at [http://localhost:5173](http://localhost:5173). You can also preview the docs once you have opened a PR. You will see a bot add a comment to a link where the documentation with your changes lives.

---
**NOTE**

The `preview` command only works with existing doc files. When you add a completely new file, you need to update `_toctree.yml` & restart `preview` command (`ctrl-c` to stop it & call `doc-builder preview ...` again).

If the preview won't works, for example, Mac user without GPU or pytorch issue, there is [an alternative](https://github.com/huggingface/doc-builder/issues/614#issuecomment-3182446282) to generate html files and you can check those files via you own browser.

---

## Adding a new element to the navigation bar
Expand Down