Flakeheaven config for using flake8-rst-docstrings (https://github.com/peterjc/flake8-rst-docstrings/) with Sphinx

pyproject.toml

[tool.flakeheaven]

max-line-length = 88
format = 'grouped'

# Options for flake8-rst-docstrings
# https://github.com/peterjc/flake8-rst-docstrings#configuration

rst-roles = [
  # Built-in roles
  # https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html
	'any',
	'ref',
	'doc',
	'download',
	'numref',
	'envvar',
	'token',
	'keyword',
	'option',
	'term',
	'code',
	'math',
	'eq',
	'abbr',
	'command',
	'dfn',
	'file',
	'guilabel',
	'kbd',
	'mailheader',
	'makevar',
	'manpage',
	'menuselection',
	'mimetype',
	'newsgroup',
	'program',
	'regex',
	'samp',
	'rfc',
	'pep',

  # Python domain roles
  # https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-python-objects
	':py:mod',
	':py:func',
	':py:data',
	':py:const',
	':py:class',
	':py:meth',
	':py:attr',
	':py:exc',
	':py:obj',
  # If default-domain is set to Python (enabled by default)
	'mod',
	'func',
	'data',
	'const',
	'class',
	'meth',
	'attr',
	'exc',
	'obj',
]

rst-directives = [
  # Built-in
  # https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
	'toctree',
	'note',
	'warning',
	'versionadded',
	'versionchanged',
	'deprecated',
	'seealso',
	'rubric',
	'centered',
	'hlist',
	'highlight',
	'literalinclude',
	'glossary',
	'sectionauthor',
	'codeauthor',
	'index',
	'only',
	'tabularcolumns',
	'math',
	'productionlist',
	'default-domain',

  # Standard domain
  # https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-standard-domain
	'option',
	'envvar',
	'program',
	'describe',
	'object',

  # Python domain
  # https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain
	'module',
	'currentmodule',
	'function',
	'data',
	'exception',
	'class',
	'attribute',
	'property',
	'staticmethod',
	'classmethod',
	'decorator',
	'decoratormethod',
]