doc: user mkdocs

dev-requirements.txt

@@ -1 +1,2 @@
 pytest-ckan
+mkdocs>=1.6.1,<1.7

docs/index.md

@@ -0,0 +1,27 @@
+[![Tests](https://github.com/DataShades/ckanext-event-audit/actions/workflows/test.yml/badge.svg)](https://github.com/DataShades/ckanext-event-audit/actions/workflows/test.yml)
+
+# ckanext-event-audit
+
+This extension will capture and retain a comprehensive record of all changes within a CKAN app. 
+
+Read the [documentation](https://datashades.github.io/ckanext-event-audit/) for a full user guide.
+
+## Developer installation
+
+To install ckanext-event-audit for development, activate your CKAN virtualenv and
+do:
+
+    git clone https://github.com//ckanext-event-audit.git
+    cd ckanext-event-audit
+    pip install -e .
+    pip install -r dev-requirements.txt
+
+## Tests
+
+To run the tests, do:
+
+    pytest --ckan-ini=test.ini
+
+## License
+
+[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)

mkdocs.yml

@@ -0,0 +1,77 @@
+site_name: ckanext-popo
+site_url: https://.github.io/ckanext-popo/
+
+repo_url:  https://github.com//ckanext-popo
+
+markdown_extensions:
+  - pymdownx.snippets # include code snippets
+  - pymdownx.highlight # code highlighting
+  - pymdownx.inlinehilite # inline code highlighting
+  - pymdownx.blocks.admonition # alert boxes
+  - pymdownx.blocks.details # accordions
+  - pymdownx.blocks.tab:
+      alternate_style: true
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+
+plugins:
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_root_full_path: false
+            show_root_toc_entry: false
+            show_symbol_type_heading: true
+            show_source: false
+            docstring_section_style: spacy
+  - search:
+      separator: '[\s\-\.\_]+'
+
+watch:
+  - README.md
+
+theme:
+  name: material
+  logo: img/logo.png
+  favicon: img/favicon.ico
+  palette:
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: blue
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to system preference
+
+  features:
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.footer
+    - navigation.indexes
+    - navigation.top
+    - content.code.copy
+    - content.code.select
+    - content.code.annotate
+
+nav:
+  - index.md
+  - hui.md