From 4cdb679841c7dfbe0a7783d1df36438706a1752a Mon Sep 17 00:00:00 2001
From: xiaywang <xiaywang@student.ethz.ch>
Date: Tue, 18 Jan 2022 20:50:59 +0100
Subject: [PATCH] create docs with github pages using material for mkdocs

---
 .github/workflows/ci.yml | 16 ++++++++++++++++
 docs/index.md            | 15 +++++++++++++++
 mkdocs.yml               | 10 ++++++++++
 3 files changed, 41 insertions(+)
 create mode 100644 .github/workflows/ci.yml
 create mode 100644 docs/index.md
 create mode 100644 mkdocs.yml

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 000000000..3aa033fda
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,16 @@
+name: ci # (1)!
+on:
+  push:
+    branches:
+      - master # (2)!
+      - main
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material # (3)!
+      - run: mkdocs gh-deploy --force
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 000000000..2fe78ae4c
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,15 @@
+# PULP DSP
+
+The PULP DSP library implements functions for Digital Signal Processing (DSP) on [Parallel Ultra Low Power (PULP) platform](https://pulp-platform.org/).
+
+## Getting Started
+
+Please refer to `README.md`.
+
+## Documentation
+
+The documentation is built from the latest master and hosted at github pages: [https://pulp-platform.github.io/pulp-dsp](https://pulp-platform.github.io/pulp-dsp).
+
+## Licensing
+
+Snitch is being made available under permissive open source licenses. See the `README.md` for a more detailed break-down.
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 000000000..d8ca1fa77
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,10 @@
+site_name: PULP DSP
+theme:
+  name: material
+
+  icon:
+    repo: fontawesome/brands/github
+
+repo_url: https://github.com/pulp-platform/pulp-dsp
+repo_name: pulp-platform/pulp-dsp
+