Changes documentation to mkdocs.

.github/workflows/build-docs.yml

@@ -1,39 +1,59 @@
-#Github Workflow to run test documentation built
-#
-#SPDX-FileCopyrightText: 2020 IntelMQ Team <[email protected]>
-#SPDX-License-Identifier: AGPL-3.0-or-later
-#
-name: "Build the documentation with sphinx"
+name: "Build and publish documentation"
+
 on:
   push:
-    branches: [develop, maintenance, master]
-    paths-ignore:
-      - '.github/**'
+    branches:
+      - develop
+      - maintenance
+      - mkdocs
+
   pull_request:
-    branches: [develop, maintenance]
-    paths-ignore:
-      - '.github/**'
+    branches:
+      - develop
+      - maintenance
+      - mkdocs
+
+  release:
+    types:
+      - published
+
+permissions:
+  contents: write
 
 jobs:
-  documentationbuild:
+  build:
     runs-on: ubuntu-latest
-    name: Build the documentation
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
-
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: "Checkout repository"
+        uses: actions/checkout@v3
+
+      - name: "Setup python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: "Install build dependencies"
+        run: |
+          pip install mkdocs-material mike lunr pygments mkdocstrings[python] mkdocs-material mkdocs-glightbox mkdocs-redirects mkdocs-minify-plugin
+
+      - name: "Prepare git"
+        run: |
+          git fetch origin gh-pages --depth=1
+          git config user.name intelmq-bot
+          git config user.email intelmq-bot
 
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
+      - name: "Build docs without publishing"
+        if: github.event_name == 'pull_request'
+        run: |
+          mkdocs build
 
-    - name: Install documentation dependencies
-      run: pip install -r docs/requirements.txt
+      - name: "Build docs with version tag and publish"
+        if: github.event_name == 'release'
+        run: |
+          mike deploy --push --force --update-aliases ${{ github.ref_name }} latest
+#          mike set-default --push latest --force
 
-    - name: Build documentation
-      run: make -C docs html
+      - name: "Build docs with branch tag and publish"
+        if: github.event_name == 'push'
+        run: |
+          mike deploy --push --force ${{ github.ref_name }}

.gitignore

@@ -29,11 +29,10 @@ src/
 .venv/
 .env
 
-# sphinx
-docs/source
-docs/_build
-docs/user/feeds.rst
-docs/dev/harmonization-fields.rst
+# mkdocs
+#docs/user/feeds.md
+#docs/dev/harmonization-fields.md
+docs_build
 
 # Debian build filed
 debian/files

README.md

@@ -0,0 +1 @@
+docs/index.md

SECURITY.md

@@ -3,12 +3,8 @@
    SPDX-License-Identifier: AGPL-3.0-or-later
 -->
 
-IntelMQ Security Notes
-======================
+# Found a security issue?
 
-Found a security issue?
------------------------
-
-In case you find security-relevant bugs in IntelMQ, please contact [email protected].
+In case you find security-relevant bugs in IntelMQ, please contact [[email protected]](mailto:[email protected]).
 More information including the PGP key can be found on [CERT.at's website](https://www.cert.at/about/contact/contact_en.html).