improve docs for pdoc

bioimage-io · Feb 28, 2024 · 2285343 · 2285343
1 parent d50d68a
commit 2285343
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,5 @@
 build/
 cache
 dist/
+docs/
 typings/pooch/
diff --git a/bioimageio/core/__init__.py b/bioimageio/core/__init__.py
@@ -1,3 +1,7 @@
+"""
+.. include:: ../../README.md
+"""
+
 import json
 
 from bioimageio.core.utils import files
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,4 +6,5 @@ @@
     build/
     cache
     dist/
+    docs/
     typings/pooch/