chore: Switch docs config from sphinx to mkdocs

.github/workflows/publish-docs.yaml

@@ -36,15 +36,14 @@ jobs:
 
       - name: Add GitHub Pages Config
         run: |
-          touch docs/build/html/.nojekyll
-          echo "protect.docs.rungalileo.io" > docs/build/html/CNAME
+          touch site/.nojekyll
 
       - name: Pushes to another repository
         uses: cpina/github-action-push-to-another-repository@main
         env:
           SSH_DEPLOY_KEY: ${{ secrets.SSH_PROTECT_DOCS_DEPLOY_KEY }}
         with:
-          source-directory: "docs/build/html"
+          source-directory: "site/"
           target-directory: "docs/"
           destination-github-username: "rungalileo"
           destination-repository-name: "protect-docs"

.prettierignore

@@ -0,0 +1,2 @@
+index.md
+CHANGELOG.md

docs/CNAME

@@ -0,0 +1 @@
+protect.docs.rungalileo.io

docs/index.md

@@ -0,0 +1,3 @@
+::: galileo_protect
+    options:
+      show_submodules: false

mkdocs.yml

@@ -0,0 +1,61 @@
+site_name: Galileo Protect
+
+nav:
+  - Galileo Protect Reference: index.md
+
+theme:
+  name: material
+  favicon: images/favicon.png
+  logo: images/logo.png
+  features:
+    - search.suggest
+    - search.highlight
+    - search.share
+    - content.code.annotate
+    - content.code.copy
+    - content.code.select
+    - navigation.expand
+    - navigation.path
+    - navigation.footer
+    - navigation.top
+    - toc.integrate
+  palette:
+    primary: deep purple
+    accent: purple
+copyright: Copyright © 2024 Galileo Technologies, Inc.
+extra:
+  generator: false
+
+markdown_extensions:
+  - toc:
+      permalink: true
+      toc_depth: 2
+
+plugins:
+  - search
+  - autorefs
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_submodules: true
+            show_source: false
+            preload_modules:
+              - galileo_core
+            filters: ["!__version__"]
+            members: true
+            members_order: source
+            docstring_style: "numpy"
+            docstring_section_style: "list"
+            show_signature_annotations: true
+            show_symbol_type_toc: true
+            signature_crossrefs: true
+            show_symbol_type_heading: true
+            unwrap_annotated: true
+            show_if_no_docstring: true
+            load_external_modules: true
+            merge_init_into_class: true
+            separate_signature: true
+            extensions:
+              - griffe_typingdoc
+              - griffe_fieldz: { include_inherited: true }