Skip to content

docs: Add error resolution for missing watchdog package #1097

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add error resolution for missing watchdog package #1097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,13 @@ Once you're happy with your changes, you can preview how they'll look by first i
pip install hf-doc-builder
```

Common Error: ImportError: Please install watchdog

If you encounter an ImportError when running the doc-builder preview command, it means the watchdog Python package is missing. You can resolve this by installing the package with the following command:
```
pip install watchdog
```

```
doc-builder preview course ../course/chapters/LANG-ID --not_python_module
```
Expand Down