Publish documentation online

Author: mikromyra

.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+name: Publish documentation
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - .github/workflows/docs.yml
+      - docs/**
+      - mkdocs.yml
+
+permissions:
+  id-token: write
+  pages: write
+
+jobs:
+  github-pages:
+    name: Publish to GitHub Pages
+    runs-on: ubuntu-latest
+
+    environment:
+      name: github-pages
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python runtime
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - name: Install dependencies
+        run: pip install mkdocs-material
+
+      - name: Build web pages
+        run: mkdocs build --site-dir=docs-site
+
+      - name: Upload to GitHub Pages
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs-site
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

README.md

@@ -2,21 +2,4 @@
 
 Use these tools to collect, process, and submit Software Accounting data to SAMS.
 
-
-## Installation
-
-Software Accounting can be installed with pip as long as you already have Python installed. Preferably use a virtual Python environment and run
-
-```
-pip install softwareaccounting
-```
-
-to install the basic feature set, or run
-
-```
-pip install 'softwareaccounting[post-receiver]'
-```
-
-if you also need the optional post-receiver.
-
-For configuration options see the docs folder, especially the [example configurations](docs/example_configuration) subdirectory.
+For instructions on how to install and configure Software Accounting, see our [documentation](https://hpc2n.github.io/softwareaccounting/) available online.

mkdocs.yml

@@ -0,0 +1,45 @@
+site_name: Software Accounting
+site_url: https://hpc2n.github.io/softwareaccounting/
+
+repo_name: hpc2n/softwareaccounting
+repo_url: https://github.com/hpc2n/softwareaccounting/
+
+theme:
+  name: material
+
+nav:
+  - Home: index.md
+  - Overview: overview.md
+  - Installation: installation.md
+  - Configuration: configuration.md
+  - Logging: logging.md
+  - Programs:
+    - Aggregator: sams-aggregator.md
+    - Collector: sams-collector.md
+    - POST Receiver: sams-post-receiver.md
+    - Software Extractor: sams-software-extractor.md
+    - Software Updater: sams-software-updater.md
+  - Modules:
+    - sams.aggregator:
+      - SoftwareAccounting: aggregator/SoftwareAccounting.md
+      - SoftwareAccountingPW: aggregator/SoftwareAccountingPW.md
+    - sams.backend:
+      - SoftwareAccounting: backend/SoftwareAccounting.md
+      - SoftwareAccountingPW: backend/SoftwareAccountingPW.md
+    - sams.loader:
+      - File: loader/File.md
+      - FileSlurmInfoFallback: loader/FileSlurmInfoFallback.md
+    - sams.output:
+      - File: output/File.md
+      - Http: output/Http.md
+    - sams.pidfinder:
+      - Slurm: pidfinder/Slurm.md
+    - sams.sampler:
+      - Core: sampler/Core.md
+      - Pressure: sampler/Pressure.md
+      - SlurmInfo: sampler/SlurmInfo.md
+      - Software: sampler/Software.md
+    - sams.software:
+      - Regexp: software/Regexp.md
+  - Versions: sams-software.md
+  - FAQ: sams-faq.md