init docs

MarkParker5 · Sep 11, 2023 · 30fbdae · 30fbdae
1 parent cf51f3e
commit 30fbdae
Show file tree

Hide file tree

Showing 8 changed files with 1,189 additions and 438 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -0,0 +1,26 @@
+name: publish docs
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install poetry
+      - run: poetry install
+      - run: poetry run mkdocs gh-deploy --force
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,5 @@ __pycache__
 
 audio/
 downloads/
+
+.DS_Store
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,12 @@
+{
+    "yaml.schemas": {
+      "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+    },
+    "yaml.customTags": [ 
+      "!ENV scalar",
+      "!ENV sequence",
+      "tag:yaml.org,2002:python/name:materialx.emoji.to_svg",
+      "tag:yaml.org,2002:python/name:materialx.emoji.twemoji",
+      "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+    ]
+}
diff --git a/docs/index.md b/docs/index.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,105 @@
+site_name: S.T.A.R.K. Docs
+site_author: Mark Parker
+site_description: Speach and Text Algorithmic Recognition Kit (S.T.A.R.K.) is a set of tools for building custom voice assistants. It is designed to be modular and extensible, allowing you to build your own custom voice assistant with ease.
+# site_url: https://markparker5.github.io/stark
+
+repo_name: MarkParker5/STARK
+repo_url: https://github.com/MarkParker5/STARK
+
+
+copyright: Copyright &copy; Mark Parker
+
+# nav:
+
+theme:
+  name: material
+  custom_dir: overrides
+  language: en
+
+  icon:
+    repo: fontawesome/brands/github
+
+  features:
+    - content.code.annotate
+    - content.code.copy
+    - content.code.select
+    - navigation.indexes
+    - navigation.instant
+    # - navigation.instant.prefetch
+    - navigation.path
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+
+  palette: 
+
+    # Palette toggle for automatic mode
+    # - media: "(prefers-color-scheme)"
+    #   primary: orange
+    #   accent: orange
+    #   toggle:
+    #     icon: material/brightness-auto
+    #     name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      primary: orange
+      accent: orange
+      scheme: default 
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      primary: orange
+      accent: orange
+      scheme: slate
+      toggle:
+        icon: material/weather-night
+        name: Switch to system preference
+
+extra:
+  generator: false
+
+  social:
+    - icon: fontawesome/brands/github 
+      link: https://github.com/ParkerIndustries
+
+  features:
+    - navigation.footer
+
+  analytics:
+    provider: google
+    property: G-NMVH5RVSYB
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - pymdownx.caret
+  - pymdownx.mark
+  - pymdownx.tilde
+  - toc:
+      permalink: true
+
+plugins:
+  - offline
+  - search
+  - social
+  # - optimize
+  # - tags
+  - swagger-ui-tag
+  - git-revision-date-localized:
+      enable_creation_date: true
+      type: timeago
+  # - git-committers:
+  #     repository: MarkParker5/STARK
+  #     branch: master
diff --git a/overrides/main.html b/overrides/main.html
@@ -0,0 +1,3 @@
+{% extends "base.html" %}
+
+{% block announce %}{% endblock %}
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -17,6 +17,9 @@ pydantic = "^1.10.4"
 vosk = "0.3.44"
 google-cloud-texttospeech = "^2.14.1"
 torch = "^1.13.1"
+mkdocs-material = "^9.2.8"
+mkdocs-git-revision-date-localized-plugin = "^1.2.0"
+mkdocs-swagger-ui-tag = "^0.6.4"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.2.1"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -13,3 +13,5 @@ __pycache__

		audio/
		downloads/

		.DS_Store
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		{% extends "base.html" %}

		{% block announce %}{% endblock %}