Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create readthedocs.yml #939

Merged
merged 5 commits into from
Jun 21, 2023
Merged

Create readthedocs.yml #939

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d2d2256
Create readthedocs.yml
lee1043 Jun 21, 2023
bba25ee
Update dev.yml
lee1043 Jun 21, 2023
fd22735
pre-commit clean up
lee1043 Jun 21, 2023
f839fdd
clean up and update
lee1043 Jun 21, 2023
5b8189b
Merge branch 'main' into lee1043-patch-1
lee1043 Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Prev Previous commit
Next Next commit
clean up and update
  • Loading branch information
@lee1043
lee1043 committed Jun 21, 2023
commit f839fdd722e5b16e55c0e6d599d2ff66d061d883
0 conda-env/conda-env/readthedocs.yml → conda-env/readthedocs.yml
View file
Open in desktop
File renamed without changes.
8 changes: 7 additions & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down