Fix 52 add mkdocs (#73)

* fix #52 add mkdocs

* add mkdocs ci scripts

* add document link

.github/workflows/python-package.yml

@@ -62,6 +62,6 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }} # required
           verbose: true # optional (default = false)
 
-      # # Build Mkdocs
-      # - name: Build Mkdocs
-      #   run: poetry run mkdocs build
+      # Build Mkdocs
+      - name: Build Mkdocs
+        run: poetry run mkdocs build

.github/workflows/python-publish.yml

@@ -41,4 +41,4 @@ jobs:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}
       - run: poetry install --with dev
-      # - run: poetry run mkdocs gh-deploy --force
+      - run: poetry run mkdocs gh-deploy --force

README.ipynb

@@ -17,6 +17,12 @@
     "[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)\n",
     "[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n",
     "[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n",
+    "\n",
+    "\n",
+    "\n",
+    "### Table of Contents\n",
+    "\n",
+    "- [Documentation](https://livingbio.github.io/typed-ffmpeg/)\n",
     "\n"
    ]
   },

README.md

@@ -14,6 +14,12 @@
 
 
 
+### Table of Contents
+
+- [Documentation](https://livingbio.github.io/typed-ffmpeg/)
+
+
+
 
 ## Installation
 

docs/ffmpeg_media_type.md

@@ -0,0 +1 @@
+::: ffmpeg_media_type

docs/index.md

@@ -0,0 +1 @@
+--8<-- "README.md"

mkdocs.yml

@@ -0,0 +1,109 @@
+site_name: ffmpeg-media-type
+site_description: Data validation using Python type hints
+strict: true
+site_url: https://livingbio.github.io/ffmpeg-media-type/
+
+theme:
+  name: "material"
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: pink
+      accent: pink
+      toggle:
+        icon: material/lightbulb-outline
+        name: "Switch to dark mode"
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: pink
+      accent: pink
+      toggle:
+        icon: material/lightbulb
+        name: "Switch to light mode"
+  features:
+    - content.tabs.link
+    - content.code.annotate
+    - content.code.copy
+    - announce.dismiss
+    - navigation.tabs
+
+repo_name: livingbio/ffmpeg-media-type
+repo_url: https://github.com/livingbio/ffmpeg-media-type
+edit_uri: edit/main/docs/
+
+# https://www.mkdocs.org/user-guide/configuration/#validation
+# validation:
+#   omitted_files: warn
+#   absolute_links: warn
+#   unrecognized_links: warn
+
+nav:
+  - Get Started:
+      - Overview: index.md
+  - API Documentation:
+      - ffmpeg_media_type: ffmpeg_media_type.md
+
+watch:
+  - "src"
+  - "docs"
+  - "README.md"
+
+# https://www.mkdocs.org/user-guide/configuration/#validation
+# validation:
+#   omitted_files: warn
+#   absolute_links: warn
+#   unrecognized_links: warn
+
+markdown_extensions:
+  - attr_list
+  - admonition
+  - callouts
+  - footnotes
+  - pymdownx.details
+  - pymdownx.magiclink
+  - pymdownx.snippets:
+      check_paths: true
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.highlight:
+      pygments_lang_class: true
+  - pymdownx.extra
+  - pymdownx.tilde
+  - tables
+  - toc:
+      permalink: true
+      title: Page contents
+
+plugins:
+  - search
+  - mknotebooks:
+      execute: false
+      timeout: 100
+      # preamble:  "<path/to/your/script>"
+      allow_errors: true
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            docstring_options:
+              ignore_init_summary: true
+            filters: ["!^_"]
+            heading_level: 1
+            inherited_members: true
+            merge_init_into_class: true
+            separate_signature: true
+            show_root_heading: true
+            show_root_full_path: false
+            show_signature_annotations: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            signature_crossrefs: true
+            summary: true
+            docstring_section_style: table
+            order: source
+            docstring_style: google
+            extensions:
+              - griffe_inherited_docstrings