Merge remote-tracking branch 'upstream/build-docs' into docs/comprehensive-mkdocs-setup

Author: tysoncung

.gitignore

@@ -10,3 +10,6 @@ dist/
 .vscode
 .tox/
 coverage.xml
+
+# mkdocs
+site/

mkdocs.yml

@@ -0,0 +1,45 @@
+
+site_name: backoff
+repo_url: https://github.com/python-backoff/backoff
+repo_name: python-backoff/backoff
+theme:
+  name: material
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - content.code.copy
+    - content.code.select
+    - content.code.annotate
+    - navigation.indexes
+    - navigation.sections
+    - navigation.tabs
+    - navigation.top
+    - search.highlight
+    - search.share
+    - search.suggest
+markdown_extensions:
+  - pymdownx.highlight
+  - pymdownx.superfences
+  - pymdownx.inlinehilite
+  - admonition
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            docstring_style: google
+            show_root_heading: yes
+            show_source: yes
+nav:
+  - "index.md"
+  - "api.md"

pyproject.toml

@@ -39,10 +39,16 @@ Repository = "https://github.com/python-backoff/backoff"
 
 [dependency-groups]
 dev = [
+    { include-group = "docs" },
     { include-group = "lint" },
     { include-group = "test" },
     { include-group = "typing" },
 ]
+docs = [
+    "mkdocs>=1.5.3",
+    "mkdocs-material>=9.2.7",
+    "mkdocstrings[python]>=0.22.0",
+]
 lint = [
     "ruff>=0.12.9",
 ]