add docs

.github/workflows/build_docs.yml

@@ -0,0 +1,29 @@
+name: build_docs.yml
+on:
+  push:
+    branches:
+      - main
+      - napytau/tooling/add-documentation-framework
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

docs/docs/index.md

@@ -0,0 +1,23 @@
+# Welcome to NapyTau
+
+## About
+
+NapyTau is a Python project, made as a successor to the Napatau tool. It's primary purpose is to calculate `Tau`, also
+known as the lifetime. NapyTau primarily aims at modernizing the user experience of the original Napatau tool, by providing
+a more user-friendly interface and a more modern look. Furthermore, NapyTau provides a command line interface, allowing its usage in automated scripts.
+
+## Tech Stack
+
+The NapyTau source is written entirely in Python, with the GUI being built using the `tkinter` library. Specifically, the `customtk` component library is used to provide a more modern look to the GUI. To facilitate efficient calculations, the ubiquitous `numpy` and `scipy` libraries are used.
+
+The project also provides pre-built binaries for Windows and Linux, which are built using `Nuitka`.
+
+Finally, this documentation is built using `mkdocs` and `mkdocs-material`.
+
+## Installation
+
+See [ReadMe#Installation](https://github.com/BP-TPSE-Projektgruppe-80/NaPyTau/blob/main/README.md#installation) for installation instructions.
+
+## Contributing
+
+See [ReadMe#Contributing](https://github.com/BP-TPSE-Projektgruppe-80/NaPyTau/blob/main/README.md#installation) for information on contributing.

docs/mkdocs.yml

@@ -0,0 +1,22 @@
+site_name: NapyTau Documentation
+theme:
+  name: material
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/weather-sunny
+        name: Light
+      primary: lavender
+      accent: pink
+
+    - scheme: slate
+      toggle:
+          icon: material/weather-night
+          name: Dark
+      primary: slate
+      accent: pink
+  font:
+    text: Roboto
+    code: Roboto Mono
+  logo: /ressources/logo.jpg
+  favicon: /ressources/favicon.ico

pyproject.toml

@@ -7,6 +7,7 @@ requires-python = ">=3.12"
 dependencies = [
     "customtkinter>=5.2.2",
     "matplotlib>=3.10.0",
+    "mkdocs-material>=9.5.49",
     "numpy>=2.2.0",
     "scipy>=1.14.1",
 ]