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

Auto-format documentation source? #308

Open
lengau opened this issue Dec 20, 2024 · 1 comment
Open

Auto-format documentation source? #308

lengau opened this issue Dec 20, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation Enhancement New feature or request

Comments

@lengau
Copy link
Contributor

lengau commented Dec 20, 2024

Should we auto-format our documentation source? The only formatter I know of right now that doesn't appear to be entirely abandoned is docstrfmt - maybe we can use it, since it'll format both the docstrings and the rst files?

@lengau lengau added documentation Improvements or additions to documentation Enhancement New feature or request labels Dec 20, 2024
@medubelko
Copy link
Contributor

Noting that this would need fairly rigorous testing against our Starter Pack conventions, and I have some particular bugbears with RST/MD readability that I would prefer any formatter we select to handle.

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 Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants