From 8a830301b913172a2d32cbfe9fe4e9550a2ba803 Mon Sep 17 00:00:00 2001
From: Yixing Lao <yixing.lao@gmail.com>
Date: Sun, 29 Dec 2024 00:40:46 +0800
Subject: [PATCH] docs(README.md): simplify documentation build commands by
 using `-C` flag with `make` and update paths for clarity

---
 README.md | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 81915756..5888b71f 100644
--- a/README.md
+++ b/README.md
@@ -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.