Merge pull request #939 from PCMDI/lee1043-patch-1

Create readthedocs.yml

conda-env/dev.yml

@@ -1,40 +1,44 @@
 # Conda pcmdi_metrics development environment
 name: pcmdi_metrics_dev
 channels:
- - conda-forge
- - defaults
+  - conda-forge
+  - defaults
 dependencies:
- # Base
- # ==================
- - python=3.10.10
- - pip=23.1.2
- - numpy=1.23.5
- - cartopy=0.21.1
- - matplotlib=3.7.1
- - cdat_info=8.2.1
- - cdms2=3.1.5
- - genutil=8.2.1
- - cdutil=8.2.1
- - cdp=1.7.0
- - eofs=1.4.0
- - seaborn=0.12.2
- - enso_metrics=1.1.1
- - xcdat=0.5.0
- - xmltodict=0.13.0
- - setuptools=67.7.2
- - netcdf4=1.6.3
- - regionmask=0.9.0
- - rasterio=1.3.6
- - shapely=2.0.1
- # Testing
- # ==================
- - pre_commit=3.2.2
- - pytest=7.3.1
- - pytest-cov=4.0.0
- # Developer Tools
- # ==================
- - jupyterlab=3.6.3
- - nb_conda=2.2.1
- - nb_conda_kernels=2.3.1
+ # ==================
+ # Base
+ # ==================
+ # NOTE: If versions are updated, also `additional_dependencies` list for mypy in `.pre-commit-config.yaml`
+ - python=3.10.10
+ - pip=23.1.2
+ - numpy=1.23.5
+ - cartopy=0.21.1
+ - matplotlib=3.7.1
+ - cdat_info=8.2.1
+ - cdms2=3.1.5
+ - genutil=8.2.1
+ - cdutil=8.2.1
+ - cdp=1.7.0
+ - eofs=1.4.0
+ - seaborn=0.12.2
+ - enso_metrics=1.1.1
+ - xcdat=0.5.0
+ - xmltodict=0.13.0
+ - setuptools=67.7.2
+ - netcdf4=1.6.3
+ - regionmask=0.9.0
+ - rasterio=1.3.6
+ - shapely=2.0.1
+ # ==================
+ # Testing
+ # ==================
+ - pre_commit=3.2.2
+ - pytest=7.3.1
+ - pytest-cov=4.0.0
+ # ==================
+ # Developer Tools
+ # ==================
+ - jupyterlab=3.6.3
+ - nb_conda=2.2.1
+ - nb_conda_kernels=2.3.1
 
 prefix: /opt/miniconda3/envs/pmcdi_metrics_dev

conda-env/readthedocs.yml

@@ -0,0 +1,53 @@
+name: pcmdi_metrics_rtd
+channels:
+ - conda-forge
+ - defaults
+dependencies:
+ # ==================
+ # Base
+ # ==================
+ # NOTE: If versions are updated, also `additional_dependencies` list for mypy in `.pre-commit-config.yaml`
+ - python=3.10.10
+ - pip=23.1.2
+ - numpy=1.23.5
+ - cartopy=0.21.1
+ - matplotlib=3.7.1
+ - cdat_info=8.2.1
+ - cdms2=3.1.5
+ - genutil=8.2.1
+ - cdutil=8.2.1
+ - cdp=1.7.0
+ - eofs=1.4.0
+ - seaborn=0.12.2
+ - enso_metrics=1.1.1
+ - xcdat=0.5.0
+ - xmltodict=0.13.0
+ - setuptools=67.7.2
+ - netcdf4=1.6.3
+ - regionmask=0.9.0
+ - rasterio=1.3.6
+ - shapely=2.0.1
+ # ==================
+ # Testing
+ # ==================
+ - pre_commit=3.2.2
+ - pytest=7.3.1
+ - pytest-cov=4.0.0
+ # ==================
+ # Developer Tools
+ # ==================
+ - jupyterlab=3.6.3
+ - nb_conda=2.2.1
+ - nb_conda_kernels=2.3.1 
+ # ==================
+ # Documentation
+ # ==================
+ - sphinx=5.3.0
+ - sphinx-autosummary-accessors=2022.4.0
+ - sphinx-book-theme=1.0.1
+ - sphinx-copybutton=0.5.1
+ - nbsphinx=0.9.1
+ - pandoc=3.1.1
+ - ipython=8.11.0 # Required for nbsphinx syntax highlighting
+
+prefix: /opt/miniconda3/envs/pcmdi_metrics_rtd

docs/README.md

@@ -5,7 +5,13 @@ This branch hosts the online documentation for the PCMDI Metrics packages. Provi
 Checking out and making changes to the docs branch:
 ---------------------------------------------------
 
-You must be in a conda environment with "sphinx" and "sphinx_rtd_theme" installed
+You must be in a conda environment with "sphinx", "sphinx_rtd_theme", and other sphinx-related libraries listed in `conda-env/readthedocs.yml` installed. Otherwise, create your env following below
+```
+cd pcmdi_metrics
+conda env create -n <new environment name> -f conda-env/readthedocs.yml
+conda activate <new environment name>
+```
+Once your environment is ready
 ```
 git pull origin main (optional, grab latest updates)
 git checkout -b <new branch name>