The NorESM documentation on Read the Docs is built from the branches in this repository. The branches correspond to different versions of the NorESM source code.
| version | build status | note |
|---|---|---|
| NorESM1 | Model version used for CMIP5 and IPCC AR5 | |
| NorESM2 | Model version used for CMIP6 and IPCC AR6 | |
| NorESM2.1 | bugfix and technical release version | |
| NorESM2.2 | unvalidated development version |
- step 1: Fork this repository as shown in the figure below.
- step 2: Go online to NorESM documentation and whenever you would like to update the documentation, click on "Edit on GitHub".
- step 3: Then click on the "pen" (see image below) and write your text (reStructuredText)
- step 4: Save your changes in your forked repository and create a pull request.
If you do not like to update the documentation online and prefer to use your favorite editor locally on your machine/laptop, you can skip step-3 and 4 and then clone your forked repository to edit the files locally. Once pushed to your forked github repository, you can create a pull request and propose your changes.
Example on how to see your changes locally with sphinx:
Prepare your PC/MAC
$ conda install sphinx $ conda install -c conda-forge sphinxcontrib-bibtex $ conda install -c conda-forge sphinx_rtd_themeCopy NorESMdoc repository to local
$ git clone [email protected]:NorESMhub/NorESM-docs.gitgo to NorESM-docs dir
$ sphinx-build . _buildopen _build/index.html in browser
More info See https://coderefinery.github.io/documentation/sphinx/
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent