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

Configure flake8-rst-docstrings for Sphinx #876

Merged
merged 1 commit into from
Apr 15, 2021

Conversation

cjolowicz
Copy link
Owner

@cjolowicz cjolowicz commented Apr 15, 2021

Closes #794

This PR configures flake8-rst-docstrings to recognize some common Sphinx roles and directives:

  • class
  • const
  • func
  • meth
  • mod
  • ref
  • deprecated

Configure some common Sphinx roles and directives.
@cjolowicz cjolowicz added the testing Adding missing tests or correcting existing tests label Apr 15, 2021
@cjolowicz cjolowicz added this to the 2021.4.15 milestone Apr 15, 2021
@cjolowicz cjolowicz changed the title 🔧 [flake8] Configure flake8-rst-docstrings for Sphinx Configure flake8-rst-docstrings for Sphinx Apr 15, 2021
@cjolowicz cjolowicz merged commit dff7a63 into main Apr 15, 2021
@cjolowicz cjolowicz deleted the flake8-rst-docstrings-and-sphinx branch April 15, 2021 15:45
@cjolowicz cjolowicz mentioned this pull request Apr 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
testing Adding missing tests or correcting existing tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Configure flake8-rst-docstrings for common Sphinx roles
1 participant