readme.md 712 Bytes
Newer Older
Xuqian Yan's avatar
Xuqian Yan committed
1
2
This documentation is shown on <https://nexus-e.readthedocs.io/en/latest/>.  

Xuqian Yan's avatar
Xuqian Yan committed
3
How to compile the whole documentation locally:
4
- install [Anaconda](https://docs.anaconda.com/anaconda/install/)
5
- create a virtual environment for better python package management. Here are example codes using conda:
6
    - conda create -n **nexuse-doc** python=3.7 (you can change the "nexuse-doc" to any name for the virtual environment; the python version should be aligned with the version specified in docs/.readthedocs.yml) 
7
8
9
    - conda activate **nexuse-doc**
    - cd to "docs" folder of this repository
    - pip install -r "requirements.txt"
Xuqian Yan's avatar
Xuqian Yan committed
10
11
- make html
- open build/html/index.html
12
- Webpage will be shown in the browser