docs: initialize mkdocs

speaches-ai · Oct 2, 2024 · d651aba · d651aba
1 parent 3dcd817
commit d651aba
Show file tree

Hide file tree

Showing 4 changed files with 321 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+Coming soon...
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,28 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
+site_name: Faster Whisper Server Documentation
+repo_url: https://github.com/fedirz/faster-whisper-server
+theme:
+  language: en
+  name: material
+  palette:
+    scheme: default
+    primary: deep orange
+    accent: indigo
+  features:
+    - content.tabs.link
+    - content.code.copy
+    - navigation.instant
+    - navigation.instant.progress
+    - navigation.instant.prefetch
+    - search.highlight
+    - search.share
+plugins:
+  - mkdocstrings:
+      default_handler: python
+nav:
+  - Home: index.md
+markdown_extensions:
+  - admonition
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
diff --git a/pyproject.toml b/pyproject.toml
@@ -23,6 +23,8 @@ dev = [
     "anyio>=4.4.0",
     "basedpyright>=1.18.0",
     "pytest-antilru>=2.0.0",
+    "mkdocs-material>=9.5.39",
+    "mkdocstrings[python]>=0.26.1",
     "pytest-asyncio>=0.24.0",
     "pytest-xdist>=3.6.1",
     "pytest>=8.3.3",