Add flake8-rst-docstrings to linting rules (#70)

* Add flake8-rst-docstrings description

* Add RST validation code

* Add flake8-rst-docstrings to lint session

* Add flake8-rst-docstrings via Poetry

Co-authored-by: Paulo Costa <pcosta@firstrepublic.com>

Author: paw-lu

README.md

@@ -50,6 +50,7 @@ The linter suite uses the following tools and Flake8 plugins:
 - [flake8-bugbear](https://github.com/PyCQA/flake8-bugbear) to detect bugs and design problems
 - [flake8-docstrings](https://gitlab.com/pycqa/flake8-docstrings) for integration with pydocstyle
 - [flake8-import-order](https://github.com/PyCQA/flake8-import-order) to check the order of import statements
+- [flake8-rst-docstrings](https://github.com/peterjc/flake8-rst-docstrings) to check that docstrings are valid reStructuredText
 - [mccabe](https://github.com/PyCQA/mccabe) to limit the code complexity
 - [pep8-naming](https://github.com/pycqa/pep8-naming) to enforce naming conventions from [PEP 8](http://www.python.org/dev/peps/pep-0008/)
 - [pycodestyle](https://github.com/pycqa/pycodestyle) to enforce style conventions from [PEP 8](http://www.python.org/dev/peps/pep-0008/)

{{cookiecutter.project_name}}/.flake8

@@ -1,5 +1,5 @@
 [flake8]
-select = ANN,B,B9,BLK,C,D,DAR,E,F,I,N,S,W
+select = ANN,B,B9,BLK,C,D,DAR,E,F,I,N,RST,S,W
 ignore = ANN101,E203,E501,W503
 max-line-length = 80
 max-complexity = 10

{{cookiecutter.project_name}}/noxfile.py

@@ -127,6 +127,7 @@ def lint(session: Session) -> None:
         "flake8-bugbear",
         "flake8-docstrings",
         "flake8-import-order",
+        "flake8-rst-docstrings",
         "pep8-naming",
         "darglint",
     )

{{cookiecutter.project_name}}/poetry.lock

@@ -39,6 +39,7 @@ sphinx = "^2.3.1"
 sphinx-autodoc-typehints = "^1.10.3"
 recommonmark = "^0.6.0"
 pep8-naming = "^0.9.1"
+flake8-rst-docstrings = "^0.0.13"
 
 [tool.poetry.scripts]
 {{cookiecutter.project_name}} = "{{cookiecutter.package_name}}.console:main"