EngineX-Hygon/sglang
5
0
Fork 0
Code Issues Pull Requests Actions 7 Projects Releases Wiki Activity

feat: support docs auto live-reload with sphinx-autobuild (#4111)

Browse Source 
Signed-off-by: samzong <samzong.lu@gmail.com>
Co-authored-by: zhaochenyang20 <zhaochen20@outlook.com>
This commit is contained in:
samzong
2025-03-06 14:39:34 +08:00
committed by GitHub
parent aee30630d8
commit b9b3b098b9
4 changed files with 26 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/README.md
View File

@@ -1,4 +1,5 @@
# SGLang Documentation
We recommend new contributors start from writing documentation, which helps you quickly understand SGLang codebase. Most documentation files are located under the `docs/` folder. We prefer **Jupyter Notebooks** over Markdown so that all examples can be executed and validated by our docs CI pipeline.
## Docs Workflow
@@ -20,10 +21,17 @@ Update your Jupyter notebooks in the appropriate subdirectories under `docs/`. I
# 1) Compile all Jupyter notebooks
make compile
# 2) Compile and Preview documentation locally
# 2) Compile and Preview documentation locally with auto-build
# This will automatically rebuild docs when files change
# Open your browser at the displayed port to view the docs
bash serve.sh
# 2a) Alternative ways to serve documentation
# Directly use make serve
make serve
# With custom port
PORT=8080 make serve
# 3) Clean notebook outputs
# nbstripout removes notebook outputs so your PR stays clean
pip install nbstripout
@@ -90,7 +98,7 @@ For demonstrations in the docs, **prefer smaller models** to reduce memory consu
### **Prompt Alignment Example**
When designing prompts, ensure they align with SGLang’s structured formatting. For example:
When designing prompts, ensure they align with SGLang's structured formatting. For example:
```python
prompt = """You are an AI assistant. Answer concisely and accurately.