fix #385 use ipython notebook to maintain docs

livingbio · Apr 9, 2024 · 7c8d58f · 7c8d58f
1 parent b302287
commit 7c8d58f
Show file tree

Hide file tree

Showing 4 changed files with 314 additions and 1 deletion.
diff --git a/docs/usage/how_to_use-1.ipynb b/docs/usage/how_to_use-1.ipynb
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -41,7 +41,7 @@ nav:
   - Get Started:
       - Overview: index.md
   - Usage:
-      - How to Use: usage/how_to_use.md
+      - How to Use: usage/how_to_use-1.ipynb
   - API Documentation:
       - ffmpeg: src/base.md
       - types: src/types.md
@@ -110,6 +110,7 @@ markdown_extensions:
 
 plugins:
   - search
+  - mknotebooks
   - mkdocstrings:
       handlers:
         python:

diff --git a/pyproject.toml b/pyproject.toml
@@ -75,6 +75,7 @@ mkdocstrings-python = "^1.8.0"
 pymdown-extensions = "^10.7"
 griffe_inherited_docstrings = "*"
 black = "*"
+ipykernel = "^6.29.4"
 
 [tool.mypy]
 exclude = "^(migrations|commands|sandbox|samples|sdk)/"

diff --git a/src/ffmpeg/dag/schema.py b/src/ffmpeg/dag/schema.py
@@ -65,6 +65,10 @@ def view(self, format: Literal["png", "svg", "dot"] = "png") -> str:
 
         return view(self.node, format=format)
 
+    def _repr_png_(self) -> bytes:
+        with open(self.view(format="png"), "rb") as f:
+            return f.read()
+
 
 @dataclass(frozen=True, kw_only=True)
 class Node(HashableBaseModel, ABC):