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 #625

Closed Tomaz-Vieira closed 2 months ago

Tomaz-Vieira commented 2 months ago

Adds scripts for traversing the spec types and building HTML documentation

The code for generating the docs still relies on some python 3.12 typing features, so it won't pass pyright checking since it's configured in pyproject.toml to use python 3.8. This can be fixed soon, though

Usage, for now:

cd ./scripts
PYTHONPATH=.. python -m docgen

A million warnings get emmited and the docs are generated at dist/interactive_docs*.html. The warnings are usually stuff we could fix in the spec itself (like missing examples)

Tomaz-Vieira commented 2 months ago

Closed in favor of #630, which is in this repo and therefore can pass the deployment test