documentation

Author: pnrobinson

.github/workflows/documentation.yml

@@ -0,0 +1,24 @@
+name: documentation 
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Important for the git-revision-date plugin
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - name: Install dependencies
+        run: pip install mkdocs-material mkdocs-minify-plugin mkdocs-git-revision-date-localized-plugin
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force

docs/developers.md

@@ -0,0 +1,30 @@
+
+
+
+
+
+
+
+## Documentation
+
+These pages are generated with mkdocs.
+
+To set things up, perform the following steps (substitute name of venv if needed).
+
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install --upgrade pip
+pip install mkdocs
+pip install mkdocs-material
+pip install mkdocs-material[imaging]
+pip install pillow cairosvg
+pip install mkdocs-material-extensions
+pip install mkdocstrings[python]
+```
+
+To start a local server, enter:
+```
+mkdocs serve
+```
+ 

docs/index.md

@@ -0,0 +1,4 @@
+# Ontologizer
+
+
+to do.

mkdocs.yml

@@ -0,0 +1,68 @@
+site_name: Ontologizer
+
+theme:
+  name: "material"
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.code.annotation
+    - content.code.copy
+    - content.code.select
+  language: en
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+      primary: indigo
+      accent: white
+    - scheme: slate
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
+      primary: teal
+      accent: lime
+  icon:
+    admonition:
+      note: octicons/tag-16
+      abstract: octicons/checklist-16
+      info: octicons/info-16
+      tip: octicons/squirrel-16
+      success: octicons/check-16
+      question: octicons/question-16
+      warning: octicons/alert-16
+      failure: octicons/x-circle-16
+      danger: octicons/zap-16
+      bug: octicons/bug-16
+      example: octicons/beaker-16
+      quote: octicons/quote-16
+
+
+
+nav:
+- Home: 'index.md'
+- Developers: 'developers.md'
+
+
+
+
+
+
+
+markdown_extensions:
+  - admonition
+  - footnotes
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.mark
+  - attr_list
+  - md_in_html
+  - tables
+
+copyright: |
+  &copy; 2026 <a href="https://github.com/pnrobinson"  target="_blank" rel="noopener">Peter N Robinson</a>