From 9a626e78324f8b8ebb391e55b1bcde5c3feba3c3 Mon Sep 17 00:00:00 2001 From: Jiwoo Lee Date: Tue, 20 Jun 2023 18:16:13 -0700 Subject: [PATCH] Update README.md --- docs/README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index d4f651790..fa1ce9230 100755 --- a/docs/README.md +++ b/docs/README.md @@ -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: --------------------------------------------------- @@ -52,4 +52,8 @@ Checkout and push your changes: git checkout git push ``` -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.