ReMe/docs/README.md
2024-06-17 20:12:58 +08:00

20 lines
No EOL
504 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# MemoryScope Documentation
## Build Documentation
Please use the following commands to build sphinx doc of MemoryScope.
参考https://github.com/modelscope/agentscope/blob/main/docs/README.md
```shell
# 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 sphinx_doc
# step 3: build the sphinx doc
./build_sphinx_doc.sh
# step 4: view sphinx_doc/build/html/index.html using your browser
```