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.

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

Extract documentation from docstrings for better maintenance #76

Closed
danrgll opened this issue Apr 29, 2024 · 0 comments · Fixed by #90
Closed

Extract documentation from docstrings for better maintenance #76

danrgll opened this issue Apr 29, 2024 · 0 comments · Fixed by #90
Labels
documentation Improvements or additions to documentation

Comments

@danrgll
Copy link
Collaborator

danrgll commented Apr 29, 2024

Automatically generate documentation directly from docstrings wherever possible using e.g. mkdocstrings, aiming to keep documentation up-to-date with the codebase and reducing the need for separate documentation efforts.

@danrgll danrgll added the documentation Improvements or additions to documentation label Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants