From 73aa7041bfee43581314e6f34e9a657137ecc092 Mon Sep 17 00:00:00 2001 From: Reid <61492567+reidliu41@users.noreply.github.com> Date: Sat, 29 Mar 2025 12:27:22 +0800 Subject: [PATCH] [doc] update doc (#15740) Signed-off-by: reidliu41 Co-authored-by: reidliu41 --- docs/README.md | 33 ++++++++++++++++++++++++++++----- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index 74e05ce0..dcd5e759 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,19 +2,42 @@ ## Build the docs -```bash -# Install dependencies. -pip install -r ../requirements/docs.txt +- Make sure in `docs` directory -# Build the docs. +```bash +cd docs +``` + +- Install the dependencies: + +```bash +pip install -r ../requirements/docs.txt +``` + +- Clean the previous build (optional but recommended): + +```bash make clean +``` + +- Generate the HTML documentation: + +```bash make html ``` ## Open the docs with your browser +- Serve the documentation locally: + ```bash python -m http.server -d build/html/ ``` -Launch your browser and open localhost:8000. +This will start a local server at http://localhost:8000. You can now open your browser and view the documentation. + +If port 8000 is already in use, you can specify a different port, for example: + +```bash +python -m http.server 3000 -d build/html/ +```