add docs skeleton (#37)

.github/workflows/docs.yaml

@@ -0,0 +1,29 @@
+name: publish docs
+
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install --upgrade pip
+      - run: |
+          pip install mkdocs-material
+      - run: rm -rf site
+      - run: mkdocs gh-deploy --force
+      - run: mkdocs --version

.gitignore

@@ -5,3 +5,7 @@ cache.yaml
 
 # vim temp files
 .*.sw[pnoq]
+
+# documentation working files
+site
+env

docs/index.md

@@ -0,0 +1,4 @@
+## CSCS User Environments
+
+Documentation for the user-environments provided on CSCS Alps infrastructure.
+

docs/uenv-gromacs.md

@@ -0,0 +1,3 @@
+# GROMACS
+
+supports a100.

mkdocs.yml

@@ -0,0 +1,27 @@
+site_name: alps-uenv
+nav:
+  - Home: index.md
+  - 'Environments':
+    - 'gromacs': uenv-gromacs.md
+theme:
+  name: material
+  features:
+    - content.code.copy
+    - navigation.tabs
+  palette:
+    primary: deep orange
+    accent: deep orange
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - tables
+  - toc:
+      permalink: true
+extra_css:
+  - stylesheets/extra.css
+repo_url: https://github.com/eth-cscs/alps-uenv