Skip to content

Generate / publish API docs for airshipctl api documents #593

Description

@seaneagan

Problem description (if applicable)

It would be useful to have autogenerated api documentation for the airshipctl API documents.

Proposed change

Once we are generating CRDs for all of the airshipctl API types (#574), we can use those to generate / publish api docs,
similar to how we are doing this in sip and vino:
https://github.com/airshipit/sip/blob/master/docs/api/sipcluster.md
https://github.com/airshipit/vino/blob/master/docs/api/vino.md

Once we get the generation in place we could look at publishing airshipctl/sip/vino docs all to https://docs.airshipit.org/

Metadata

Metadata

Assignees

Labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions