https://github.com/eth-cscs/cscs-docs
CSCS public documentation
https://github.com/eth-cscs/cscs-docs
cscs documentation ethz hpc hpc-applications hpc-clusters hpc-tools
Last synced: 3 months ago
JSON representation
CSCS public documentation
- Host: GitHub
- URL: https://github.com/eth-cscs/cscs-docs
- Owner: eth-cscs
- License: cc0-1.0
- Created: 2025-02-10T08:41:03.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-05T16:02:44.000Z (3 months ago)
- Last Synced: 2025-09-05T17:40:41.722Z (3 months ago)
- Topics: cscs, documentation, ethz, hpc, hpc-applications, hpc-clusters, hpc-tools
- Language: Shell
- Homepage: https://docs.cscs.ch/
- Size: 6.66 MB
- Stars: 19
- Watchers: 11
- Forks: 33
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# CSCS Documentation
This repository contains the source code for CSCS' documentation hosted at [docs.cscs.ch](https://docs.cscs.ch)
## Getting Started
If you want to contribute to the documentation, please follow the [contributing](https://docs.cscs.ch/contributing) process.
> [!IMPORTANT]
> to run the serve script, you need to first install [uv](https://docs.astral.sh/uv/getting-started/installation/).
Clone this repository on your PC/laptop, then view the documentation in a browser run `./serve`:
```bash
git clone git@github.com:${githubusername}/cscs-docs.git
cd cscs-docs
./serve
...
INFO - [08:33:34] Serving on http://127.0.0.1:8000/
```
This generates the documentation locally, which can be viewed using a local link, typically [http://127.0.0.1:8000/](http://127.0.0.1:8000/). The documentation will be rebuilt and the webpage reloaded when changed files are saved.
To build the docs in a `site` sub-directory:
```bash
./serve build
```