docs: migrating to GitHub Pages (#825)

Migrating docs from readthedocs to GitHub pages.

The existing readthedocs website will be deleted after couple of weeks.

---------

Co-authored-by: Artem Rys <[email protected]>

.github/workflows/build-test-release.yml

@@ -83,21 +83,6 @@ jobs:
           poetry install
           poetry run pytest -v tests/unit
 
-  test-splunk-doc:
-    name: Test Docs
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: true
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.7
-      - name: Install and run tests
-        run: |
-          curl -sSL https://install.python-poetry.org | python3 - --version 1.5.1
-          poetry install --with docs
-          poetry run pytest -v -m doc tests/e2e
 
   test-splunk-external:
     runs-on: ubuntu-latest
@@ -106,7 +91,6 @@ jobs:
       - pre-commit
       - fossa-scan
       - compliance-copyrights
-      - test-splunk-doc
       - test-splunk-unit
     strategy:
       fail-fast: false
@@ -154,7 +138,6 @@ jobs:
       - pre-commit
       - fossa-scan
       - compliance-copyrights
-      - test-splunk-doc
       - test-splunk-unit
     runs-on: ubuntu-latest
     strategy:

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: docs
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+      - run: |
+          curl -sSL https://install.python-poetry.org | python3 - --version 1.5.1
+          pip install mkdocs mkdocs-material mkdocstrings-python
+      - name: Deploy to GitHub Pages
+        if: github.ref_name == 'main'
+        run: mkdocs gh-deploy --force --strict
+      - name: Build Docs
+        if: github.ref_name != 'main'
+        run: mkdocs build

.licenserc.yaml

@@ -37,4 +37,3 @@ header:
     - "renovate.json"
     - "pytest_splunk_addon/.ignore_splunk_internal_errors"
     - "pytest_splunk_addon/docker_class.py"
-    - "requirements.txt"

README.md

@@ -0,0 +1,12 @@
+# pytest-splunk-addon
+
+![PyPI](https://img.shields.io/pypi/v/pytest-splunk-addon)
+![Python](https://img.shields.io/pypi/pyversions/pytest-splunk-addon.svg)
+
+## What is PSA
+
+A Dynamic test tool for Splunk Apps and Add-ons.
+
+## Usage
+
+For full usage instructions, please visit the [documentation](https://splunk.github.io/pytest-splunk-addon).