Merge pull request #25 from woonstadrotterdam/chore/read-the-docs

readthedocs

Author: sTomerG

.pre-commit-config.yaml

@@ -42,7 +42,7 @@ repos:
       - id: mypy
         description: "Mypy is an optional static type checker for Python."
         args: ["--strict", "--allow-untyped-decorators"]
-        exclude: "tests"
+        exclude: ^(tests|docs)
         additional_dependencies:
           - "pandas-stubs>=2.0.0"
           - "aiohttp>=3.10.10"

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.10"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/index.md

@@ -0,0 +1 @@
+{% include-markdown "../README.md" %}

docs/requirements.txt

@@ -0,0 +1,6 @@
+mkdocs==1.6.1
+mkdocs-material==9.6.5
+mkdocstrings==0.28.1
+mkdocstrings-python==1.16.1
+mkdocs-include-markdown-plugin==7.1.3
+markdown-callouts==0.4.0

mkdocs.yml

@@ -0,0 +1,39 @@
+site_name: Monumenten
+site_author: Tomer Gabay, Ben Verhees, Tiddo Loos
+copyright: "2025, Woonstad Rotterdam"
+
+theme:
+  name: material
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+    - search.suggest
+    - search.highlight
+    - content.code.copy
+
+markdown_extensions:
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.superfences
+  - pymdownx.details
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - attr_list
+  - md_in_html
+  - admonition
+  - github-callouts
+
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_source: true
+  - include-markdown
+
+nav:
+  - Home: index.md