[docs] New configuration of docs generation

CERT-Polska · Dec 3, 2021 · 6562410 · 6562410
1 parent 0e63269
commit 6562410
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 4 deletions.
diff --git a/.n6-version b/.n6-version
@@ -1 +1 @@
-3.0.0
+3.0.1a1
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,4 +1,15 @@
 version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.9"
+
 mkdocs:
-    configuration: mkdocs.yml
-    fail_on_warning: false
+  configuration: mkdocs.yml
+  fail_on_warning: false
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
diff --git a/docs/n6_logo.png b/docs/n6_logo.png
@@ -0,0 +1 @@
+../n6_logo.png
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+mkdocs==1.2.3
+mkdocs-material==8.0.3
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -40,6 +40,21 @@ nav:
     - API:
       - Stream API: guides/api/streamapi.md
 
-theme: readthedocs
+theme:
+    name: material
+    palette:
+      scheme: default
+      primary: white
+      accent: deep purple
+    logo: n6_logo.png
+    features:
+      - navigation.indexes
+      - navigation.sections
+      - navigation.top
 markdown_extensions:
+    - admonition
     - smarty
+    - toc:
+        title: "This document's sections"
+        permalink: true
+        toc_depth: 2
diff --git a/n6_logo.png b/n6_logo.png