When building with USE_EFA=ON, auto_discover is disabled to prevent RDMA transport installation (QP creation fails on EFA devices). This means TCP transport is also not installed automatically. Add explicit TCP transport installation for non-EFA protocols in the EFA build path. Documentation changes: - build.md: Add USE_EFA option and clarify USE_CUDA default/purpose - supported-protocols.md: Add EFA as a supported protocol - efa_transport.md: Add USE_CUDA=ON to build command, document GPU memory requirement Co-authored-by: whn09 <whn09@users.noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Teng Ma <teng-ma@linux.alibaba.com> |
||
|---|---|---|
| .. | ||
| source | ||
| Makefile | ||
| README.md | ||
| make.bat | ||
README.md
Mooncake documents
Build the docs
- Make sure in
docsdirectory
cd docs
- Install the dependencies:
pip install -r ../requirements_docs.txt
- Clean the previous build (optional but recommended):
make clean
- Generate the HTML documentation:
make html
Be sure to set locale right before building.
Open the docs with your browser
- Serve the documentation locally:
python -m http.server -d build/html/
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:
python -m http.server 3000 -d build/html/