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

Set up a doc formatter #182

Open
agoscinski opened this issue Apr 4, 2023 · 0 comments
Open

Set up a doc formatter #182

agoscinski opened this issue Apr 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@agoscinski
Copy link
Collaborator

From discussion in PR #179: We have a doc linter, but no formatter for the doc rst files (like black for code) . But all existing formatter are not so perfect for our purpose and need a bit more tuning or/and some fixes.

docstrfmt:

  1. does not recognize citation and citation-reference sphinx nodes (this is a bug of rstfmt)
  2. it is quite aggressive (creates smaller case reference)

For 1. we need to open an issue at the respective repo. For 2. we need to figure how to config it

@agoscinski agoscinski added the documentation Improvements or additions to documentation label Apr 4, 2023
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

No branches or pull requests

1 participant