Skip to content

Improve gen-schema-doc script dev experience #1280

Description

@jescalada

Right now, executing the gen-schema-doc script without setting things up correctly, results in a cryptic error that doesn't tell you that the Python library json-schema-for-humans is needed to run the underlying doc-schema.js script.

Simply executing pip install json-schema-for-humans beforehand fixes this (assuming pip is available). We should either document this somewhere, or make sure that the doc-schema.js script gives a more descriptive error when failing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions