forked from mooncake-track/Mooncake
14aea87639
* add secondary storage usage monitor * remove useless code * code format & rename memory related metrics * fix some bug * use int64_t define file capacity & add init total_file_capacity * use int64_t to define file_capacity * rename memory usage related functions * fix 2 bugs * add docs * fix code format * add more docs * use RAII way to update allocated_file_size * fix ci * fix CI compile problem |
||
|---|---|---|
| .. | ||
| 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/