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.

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

Clean template #17

Merged
merged 7 commits into from
Jun 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ How to automatically update the documentation locally during development:
$[~/PROJECT_ROOT] sphinx-autobuild content/ _build
```

The static webpage is hosted on Github and automatically build be pushing changes to the `main` branch. The build web-page is displayed as the stuff build on the `gh-pages` branch. This process is automatic. A guide to the principles can be found [here](https://pythonrepo.com/repo/executablebooks-sphinx-autobuild-python-documentation).
The static webpage is hosted on Github and automatically builded with GitHub-Actions by pushing changes from the `main` to the `gh-pages` branch. The built web-page is displayed as the stuff build on the `gh-pages` branch. This process is automatic. A guide to the principles can be found [here](https://pythonrepo.com/repo/executablebooks-sphinx-autobuild-python-documentation).
6 changes: 3 additions & 3 deletions content/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ Dependent on what you want to do you might want to use different strategies for

```{keypoints} Path variables
Throughout all this documentation we define some path variables:
- `HOME`; your home directory on the computer you are currently working on (remote or local). Typically predefined on a UNIX-system.
- `HOME`; your home directory on the computer you are currently working on (remote or local). Typically predefined on a Unix system.
- `CTSM_ROOT`; the top folder or wherever you cloned CTSM
```


## Supported machines
This tutorial assumes that you are logged into one of the clusters of Sigma2. (See [here](https://metos-uio.github.io/CTSM-Norway-Documentation/prerequisite/#needed-accesses) for ahow to get a cluster access).
This tutorial assumes that you are logged into one of the clusters of Sigma2. (See [here](https://metos-uio.github.io/CTSM-Norway-Documentation/prerequisite/#needed-accesses) for how to get cluster access).

Currently (June 2021), we support machine configurations for:
- saga (sigma2, Norway)
Expand All @@ -24,7 +24,7 @@ A user is a person that runs CTSM without modifying the source code. To get the
[~/HOME]$ git clone -b release-clm5.0 https://github.com/NordicESMhub/ctsm.git ${HOME}/ctsm_fates_emerald

In this example, we are checking out the release-clm5.0 tag and create a
new local branch (recommended). The destination of the checkout is a
new local branch (recommended). The destination of the `checkout` is a
directory (e.g. ctsm\_fates\_emerald) in our home directory.

### How to get a specific branch
Expand Down
65 changes: 0 additions & 65 deletions content/gh-pages.md

This file was deleted.

Loading