docs: ✨ Initial docsite set up.

mkdocs.yml

@@ -0,0 +1,66 @@
+site_name: "hypothesis-torch"
+site_author: Andrew P. Sansom
+site_description: "Hypothesis strategies for various Pytorch structures (including tensors and modules)."
+
+repo_url: https://github.com/qthequartermasterman/hypothesis-torch
+edit_uri: edit/main/docs/
+
+nav:
+  - quick_start_guide.md
+  - strategies.md
+  - compatability.md
+  - changelog.md
+  - contributing.md
+  - license.md
+
+theme:
+  name: material
+  features:
+    - content.action.edit
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.sections
+    - navigation.expand
+    - navigation.prune
+    - navigation.indexes
+    - navigation.top
+    - search.suggest
+  icon:
+    repo: fontawesome/brands/github
+    edit: material/pencil
+    view: material/eye
+  palette:
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      primary: black
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      primary: black
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+markdown_extensions:
+  - toc:
+      permalink: true
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: "!!python/name:pymdownx.superfences.fence_code_format"
+  - pymdownx.emoji:
+      emoji_index: "!!python/name:material.extensions.emoji.twemoji"
+      emoji_generator: "!!python/name:material.extensions.emoji.to_svg"
+
+plugins:
+  - search
+  - autolinks

pyproject.toml

@@ -48,6 +48,12 @@ dev = [
   "pytest==8.2.0",
   "pytest-cov==5.0.0"
 ]
+docs = [
+  "mkdocs==1.6.0",
+  "mkdocstrings==0.25.1",
+  "mkdocs-autolinks-plugin==0.7.1",
+  "mkdocs-material==9.4.6"
+]
 
 [project.urls]
 Homepage = "https://github.com/qthequartermasterman/hypothesis-torch"