Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate API documentation using mkdocstrings #492

Closed
raminqaf opened this issue May 22, 2024 · 2 comments · Fixed by #503
Closed

Generate API documentation using mkdocstrings #492

raminqaf opened this issue May 22, 2024 · 2 comments · Fixed by #503
Assignees
@disrupted
Labels
area/documentation Improvements or additions to documentation
Milestone
v6

Comments

@raminqaf
Copy link
Contributor

Use https://github.com/mkdocstrings/mkdocstrings to create docs for the new's KPOps Python API
@raminqaf raminqaf added the area/documentation Improvements or additions to documentation label May 22, 2024
@disrupted
Copy link
Member

as a baseline for the first iteration I'd say we should include

  • kpops API
  • Pipeline API

@disrupted disrupted added this to the v6 milestone May 28, 2024
@disrupted
Copy link
Member

had a quick play with it (mainly for L&L) https://github.com/bakdata/kpops/tree/docs/mkdocstrings

@sujuka99 sujuka99 mentioned this issue Jun 28, 2024
Merged
@disrupted disrupted assigned disrupted and unassigned sujuka99 Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@disrupted disrupted

Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Milestone
v6
Development

Successfully merging a pull request may close this issue.

Generate developer docs for Python API bakdata/kpops
3 participants
@disrupted @raminqaf @sujuka99