Add documentation checks

[ewu63]

Description

We should add some more tests to make sure the docs are okay (not just that it builds on RTD). Some available tools:

• doc8 or rstcheck for RST linting
• flake8-docstrings for checking docstrings in Python

These tools use config files, so we will have to figure out (similar to flake8) what warnings/errors to include/exclude for our use cases.

[stale]

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

This issue has been automatically marked as stale because it has not had recent activity.

[lamkina]

Another tool called interrogate that might be useful for this idea.

[stale]

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

This issue has been automatically marked as stale because it has not had recent activity.