bioimage-io / spec-bioimage-io

Specification for the bioimage.io model description file.
https://bioimage-io.github.io/spec-bioimage-io/
MIT License
18 stars 17 forks source link

Scripts for generating interactive spec docs #630

Closed Tomaz-Vieira closed 1 month ago

Tomaz-Vieira commented 2 months ago

Adds scripts to generate flattened, interactive, html documentation.

image

Scripts will traverse the python typing hierarchy and produce nested tables with yaml examples at every level of the hierarchy. This gives us maximum flexibility both for rendering as well as for interacting with the documentaiton.

The logic can then be further expanded to add more metadata, like documentation for GUIs, that can be picked up by other external tools