Merge pull request #502 from bioimage-io/download_docs

download documentation for PR preview

Author: FynnBe

.github/workflows/auto_update_main.yaml

@@ -72,6 +72,9 @@ jobs:
         mv tmp_download_counts.json dist/download_counts.json
     - name: update partner resources
       run: python scripts/update_partner_resources.py
+    - name: add documentation files to preview
+      if: github.event_name == 'pull_request'
+      run: python scripts/download_documentation.py
     - name: Upload preview of updated partner resources
       if: github.event_name == 'pull_request'
       uses: actions/upload-artifact@v2

scripts/download_documentation.py

@@ -0,0 +1,38 @@
+import warnings
+from pathlib import Path
+
+import typer
+
+from bioimageio.spec.shared import resolve_source
+from utils import yaml
+
+
+def main(
+    folder: Path = Path(__file__).parent / "../dist",  # nested folders with rdf.yaml files
+):
+    """Download the documentation file for every rdf.yaml found in (subfolders of) folder"""
+    if not folder.exists():
+        warnings.warn(f"{folder} not found")
+        return
+
+    for rdf_path in folder.glob("**/rdf.yaml"):
+        rdf = yaml.load(rdf_path)
+        if not isinstance(rdf, dict):
+            warnings.warn(f"rdf not a dict: {rdf_path}")
+            continue
+
+        doc_uri = rdf.get("documentation")
+        if not isinstance(doc_uri, str):
+            warnings.warn(f"rdf['documentation'] not a string: {rdf_path}")
+            continue
+
+        if "." in str(doc_uri):
+            type_ext = str(doc_uri).split(".")[-1]
+        else:
+            type_ext = "md"
+
+        resolve_source(doc_uri, output=rdf_path.with_name(f"documentation.{type_ext}"))
+
+
+if __name__ == "__main__":
+    typer.run(main)