Skip to content

Generate documentation for stubs #663

@lars-reimann

Description

@lars-reimann

Is your feature request related to a problem?

We don't have a way to generate documentation for stubs.

Desired solution

The CLI should be extended with a tool that takes a path to a directory containing stubs and outputs Markdown documentation for it. Ideally, it should integrate with Material for Mkdocs, so our DSL documentation is consistent with the one for the Python library.

  • Test system
  • Summary
  • Annotation
  • Class
  • Abstract class
  • Enum
  • Enum variant
  • Function
  • Pipeline
  • Schema
  • Segment
  • Internal segment
  • Attributes
  • Parameters
  • Results
  • TypeParameters
  • Link declarations together (types)
  • Link declarations together (parent classes)
  • Add source code
  • Experimental
  • Deprecated

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

No response

Metadata

Metadata

Assignees

Labels

documentation 📖Improvements or additions to documentationreleasedIncluded in a release

Type

No type

Projects

Status

✔️ Done

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions