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

Update README.md #943

Merged
merged 1 commit into from
Jun 21, 2023
Merged

Update README.md #943

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
readthedocs
-----------
This branch hosts the online documentation for the PCMDI Metrics packages. Provided here are instructions for updating the documentation.
This directory hosts the online documentation for the PCMDI Metrics packages (https://pcmdi-metrics.readthedocs.io). Provided here are instructions for updating the documentation.

Checking out and making changes to the docs branch:
---------------------------------------------------
Expand Down Expand Up @@ -52,4 +52,8 @@ Checkout and push your changes:
git checkout <branch with changes>
git push <remote name> <branch with changes>
```
Then go to your forked repo on github.com and create a Pull Request to the `main` branch. Once merged, readthedocs webhook will automatically generate the web pages.
Then go to your forked repo on github.com and create a Pull Request to the `main` branch.

Build webpages:
---------------
Once merged, go to readthedocs (https://readthedocs.org/projects/pcmdi-metrics/) to build web pages.