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: about 1 month ago
JSON representation
CSCS public documentation
- Host: GitHub
- URL: https://github.com/eth-cscs/cscs-docs
- Owner: eth-cscs
- Created: 2025-02-10T08:41:03.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-02T08:52:36.000Z (about 1 month ago)
- Last Synced: 2025-04-02T09:36:27.730Z (about 1 month ago)
- Topics: cscs, documentation, ethz, hpc, hpc-applications, hpc-clusters, hpc-tools
- Language: HTML
- Homepage: https://eth-cscs.github.io/cscs-docs/
- Size: 2.06 MB
- Stars: 9
- Watchers: 11
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Contributing: docs/contributing/index.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# CSCS Documentation
The source CSCS documentation [docs.cscs.ch](httpa://docs.cscs.ch)
> [!NOTE]
> These docs are not currently work in progress, and are not hosted at `docs.cscs.ch`.
> They can be viewed at [eth-cscs.github.io/cscs-docs](https://eth-cscs.github.io/cscs-docs)
## Getting Started
> [!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 [email protected]:${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
```