Mooncake/docs
chenyu520 c0ba3c1e55 [Doc] Document the memory fabric capability layer
Add a design note covering the capability descriptor, the conformance suite, the
path selector, dynamic loading, and the UALink backend, with the mapping onto the
existing transport tree. Add a benchmarks README and a GPU benchmark that
measures NVLink peer access versus pinned-host staging -- the payoff the path
selector captures by preferring an intra-node NVLink path over the fallback.
2026-06-26 19:20:43 +08:00
..
source [Doc] Document the memory fabric capability layer 2026-06-26 19:20:43 +08:00
Makefile [DOC] feat(docs): build documentation website for Mooncake using Sphinx (#354) 2025-05-12 23:33:18 +08:00
README.md [DOC] feat(docs): build documentation website for Mooncake using Sphinx (#354) 2025-05-12 23:33:18 +08:00
make.bat [DOC] feat(docs): build documentation website for Mooncake using Sphinx (#354) 2025-05-12 23:33:18 +08:00

README.md

Mooncake documents

Build the docs

  • Make sure in docs directory
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/