This repository contains the source code for CSCS' documentation hosted at docs.cscs.ch
Important
to run the serve script, you need to first install uv.
Clone this repository on your PC/laptop, then view the documentation in a browser run ./serve
:
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/. The documentation will be rebuilt and the webpage reloaded when changed files are saved.
To build the docs in a site
sub-directory:
./serve build