Skip to content

Commit

Permalink
docs(README.md): simplify documentation build commands by using -C
Browse files Browse the repository at this point in the history
…flag with `make` and update paths for clarity
  • Loading branch information
yxlao committed Dec 28, 2024
1 parent a9a55bc commit 8a83030
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,14 +260,13 @@ To build and view the documentation locally:
pip install -e .[docs]

# Build the documentation
cd docs
make clean && make html
make -C docs clean && make -C docs html

# To treat warnings as errors
make clean && make html SPHINXOPTS="-W --keep-going"
# (Optional) Build the documentation with warnings as errors
make -C docs clean && make -C docs html SPHINXOPTS="-W --keep-going"

# Start a local server to view the documentation (run inside `docs/`)
python -m http.server 8000 --directory _build/html
# Start a local server to view the documentation
python -m http.server 8000 --directory docs/_build/html
```

Then open your browser and navigate to `http://localhost:8000` to view the documentation.
Expand Down

0 comments on commit 8a83030

Please sign in to comment.