update docs/README.md for using conda env

ornladios · Mar 10, 2023 · 890620d · 890620d
1 parent 326f6ec
commit 890620d
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 1 deletion.
diff --git a/docs/README.md b/docs/README.md
@@ -4,7 +4,7 @@
 
 This user guide is hosted in readthedocs: https://adios2.readthedocs.io/en/latest/
 
-To generate the User Guide under docs/user_guide/build/html format from the Sphinx source files:
+To generate the User Guide under docs/user_guide/build/html format from the Sphinx source files, using pip:
 
 ```bash
 $ cd ADIOS2/docs
@@ -14,3 +14,23 @@ docs$ pip3 install -r requirements.txt
 user_guide$ cd user_guide
 user_guide$ make html
 ```
+
+Or using conda:
+
+```bash
+$ cd ADIOS2/docs
+docs$ conda env create -f environment.yml
+docs$ conda activate adios2-python-docs
+user_guide$ cd user_guide
+user_guide$ make html
+```
+
+# Updating dependencies
+
+Read the Docs uses only the environment.yml file, so if you make changes to dependencies in requirements.txt, they will not take effect in RTD.
+The requirements.txt is provided only for building locally for those who don't have conda installed.
+If you make changes to the conda environment, you should update requirements.txt as well, either manually, or by running the following command (with the conda adios2-python-docs environment activated):
+
+```bash
+docs$ pip list --format=freeze > requirements.txt
+```
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,44 @@
+alabaster==0.7.12
+Babel==2.11.0
+blockdiag==3.0.0
+breathe==4.33.0
+brotlipy==0.7.0
+certifi==2022.12.7
+cffi==1.15.1
+charset-normalizer==2.1.1
+colorama==0.4.6
+cryptography==38.0.2
+docutils==0.17
+funcparserlib==1.0.1
+idna==3.4
+imagesize==1.4.1
+importlib-metadata==4.11.4
+Jinja2==3.1.2
+MarkupSafe==2.1.1
+mpi4py==3.1.3
+numpy==1.21.6
+packaging==22.0
+Pillow==9.4.0
+pip==22.3.1
+pycparser==2.21
+Pygments==2.14.0
+pyOpenSSL==23.0.0
+PySocks==1.7.1
+pytz==2022.7
+requests==2.28.1
+setuptools==65.6.3
+snowballstemmer==2.2.0
+Sphinx==4.5.0
+sphinx-rtd-theme==1.0.0
+sphinxcontrib-applehelp==1.0.2
+sphinxcontrib-blockdiag==3.0.0
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
+typing_extensions==4.4.0
+urllib3==1.26.13
+webcolors==1.12
+wheel==0.38.4
+zipp==3.11.0