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

Developer Documentation Setup #17

Closed
Vincinator opened this issue Aug 16, 2024 · 0 comments
Closed

Developer Documentation Setup #17

Vincinator opened this issue Aug 16, 2024 · 0 comments

Comments

@Vincinator
Copy link
Contributor

What would you like to be added:
Have GitHub pipelines to automatically create documentation based on python docstrings in source code and publish it to GitHub pages.

Why is this needed:

  • Have single place of documentation in source code
  • Have documentation automatically be presented nicely via GitHub pages and read the docs style
  • Improve developer experience, and developers are needed to work on this project
@Vincinator Vincinator mentioned this issue Sep 10, 2024
Open
2 tasks
@Vincinator Vincinator transferred this issue from gardenlinux/gl-oci Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Vincinator