ReMe/docs
2024-09-11 13:30:58 +08:00
..
images rewrite readme 2024-08-29 20:36:22 +08:00
sphinx_doc * modify for sphinx doc 2024-09-06 10:25:59 +08:00
contribution.md * modify for sphinx doc 2024-09-06 10:25:59 +08:00
contribution_zh.md * modify for sphinx doc 2024-09-06 10:25:59 +08:00
installation.md fix: limit elastic search memory usage 2024-09-11 13:30:58 +08:00
installation_zh.md fix: limit elastic search memory usage 2024-09-11 13:30:58 +08:00
README.md feat: Add new modules and update README 2024-07-18 14:59:00 +08:00

MemoryScope Documentation

Build Documentation

Please use the following commands to build sphinx doc of MemoryScope.

# step 1: Install dependencies
pip install sphinx sphinx-autobuild sphinx_rtd_theme myst-parser sphinxcontrib-mermaid

# step 2: go into the sphinx_doc dir
cd docs/sphinx_doc

# step 3: build the sphinx doc
./build_sphinx_doc.sh

# step 4: view sphinx_doc/build/html/index.html using your browser
cd docs/sphinx_doc/build/html && python -m http.server 8899