To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit 02e884c0 authored by Xuqian Yan's avatar Xuqian Yan
Browse files

Minor updates in readme

parent 1b56a788
......@@ -6,23 +6,25 @@ This documentation is shown on <https://nexus-e.readthedocs.io/en/latest/>.
- install conda following [this instruction](https://conda.io/projects/conda/en/latest/user-guide/install/index.html)
- `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](https://gitlab.ethz.ch/nexus-e/nexuse-doc/-/blob/master/docs/.readthedocs.yml))
- `conda activate nexuse-doc`
- `cd` to the "docs" folder of this repository
- `cd docs`
- `pip install -r requirements.txt`
- Option 2: use [virtualenv](https://uoa-eresearch.github.io/eresearch-cookbook/recipe/2014/11/26/python-virtual-env/)
- `pip install virtualenv`
- `cd` to the repository
- `virtualenv -p python3.7 venv` (The python version should be aligned with the version specified in [docs/.readthedocs.yml](https://gitlab.ethz.ch/nexus-e/nexuse-doc/-/blob/master/docs/.readthedocs.yml).)
- (On Mac or Linux) `source venv/bin/activate` or (on Windows) `venv\Scripts\activate.bat`
- `cd` to the "docs" folder of this repository
- `cd docs`
- `pip install -r requirements.txt`
- (Need to be done every time) Once you have created a virtual environment
- Activate the virtual environment, with **one of** the following commands
- (for conda environment) `conda activate nexuse-doc`
- (for virtualenv on Mac or Linux) `source venv/bin/activate`
- (for virtualenv on Windows) `venv\Scripts\activate.bat`
- `cd docs`
- `make html`
- `open build/html/index.html`
- Webpage will be shown in the browser
- Open the compiled documentation in a browser
- (for Mac or Linus) `open build/html/index.html`
- Or, (for all operating systems) manually open the file build/html/index.html.
### Additional information
- How to deactivate a virtual environment
......@@ -52,8 +54,8 @@ This documentation is shown on <https://nexus-e.readthedocs.io/en/latest/>.
- How to check whether a package needs to be (or can be) updated
Use `pip list --outdated`.
Use `pip list --outdated`.
- How to manage dependencies with PyCharm
(On Mac) Pycharm > Preferences > Project: nexuse-doc > Project Interpreter. Here you can specify or create a virtual environment (i.e., "Project Interpreter") and view the versions (plus the available updates) of each python package. Details on [how to configure a Python interpreter](https://www.jetbrains.com/help/pycharm/configuring-python-interpreter.html#add-existing-interpreter) and [how to user requirements.txt](https://www.jetbrains.com/help/pycharm/managing-dependencies.html) in Pycharm.
(On Mac) Pycharm > Preferences > Project: nexuse-doc > Project Interpreter. Here you can specify or create a virtual environment (i.e., "Project Interpreter") and view the versions (plus the available updates) of each python package. Details on [how to configure a Python interpreter](https://www.jetbrains.com/help/pycharm/configuring-python-interpreter.html#add-existing-interpreter) and [how to user requirements.txt](https://www.jetbrains.com/help/pycharm/managing-dependencies.html) in Pycharm.
Markdown is supported
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