ReMe/docs/README.md

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