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

Convert docstrings to use mkdocstring google style #409

Closed

1 task done

kjy5 opened this issue Dec 24, 2024 · 0 comments · Fixed by #416

Closed

1 task done

Convert docstrings to use mkdocstring google style #409

kjy5 opened this issue Dec 24, 2024 · 0 comments · Fixed by #416

Assignees

Labels

Milestone

Member

kjy5 commented Dec 24, 2024 •

edited

Loading

Do this after vbl-aquarium's docs are published and there is an inventory that can be used

Cross referencing: https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories
Set docstring style to google: https://mkdocstrings.github.io/python/usage/configuration/docstrings/#docstring_style
Make building the documentation required on PR

kjy5 added the documentation label

kjy5 added this to the v2.0.X milestone

kjy5 self-assigned this

kjy5 linked a pull request

that will close this issue

409 convert docstrings to use mkdocstring google style #416

Merged

kjy5 closed this as completed in #416

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment