Commit 6ae35feb authored by Xuqian Yan's avatar Xuqian Yan
Browse files

Update readme: include instructions to create a python virtual environment

parent c6c89258
How to compile the whole documentation locally:
- install python 3.x
- pip install sphinx
- pip install recommonmark
- pip install sphinxemoji
- cd to nexuse-doc/docs
- create a virtual environment for better python package management. Here are example codes using conda:
- conda create --name **nexuse-doc** (you can change the "nexuse-doc" to any name for the virtual environment)
- conda activate **nexuse-doc**
- cd to "docs" folder of this repository
- pip install -r "requirements.txt"
- make html
- open build/html/index.html
- Webpage will be shown in the browser
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment