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

Add documentation checks #8

Open
2 tasks
ewu63 opened this issue Mar 24, 2021 · 3 comments
Open
2 tasks

Add documentation checks #8

ewu63 opened this issue Mar 24, 2021 · 3 comments
Labels
enhancement New feature or request maintenance This is for maintaining the repo stale *crickets chirp*

Comments

@ewu63
Copy link
Collaborator

ewu63 commented Mar 24, 2021

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.

@ewu63 ewu63 added enhancement New feature or request maintenance This is for maintaining the repo labels Mar 24, 2021
@stale
Copy link

stale bot commented Sep 25, 2021

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.

@stale stale bot added the stale *crickets chirp* label Sep 25, 2021
@lamkina
Copy link

lamkina commented Mar 23, 2022

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

@stale stale bot removed the stale *crickets chirp* label Mar 23, 2022
@stale
Copy link

stale bot commented Sep 19, 2022

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.

@stale stale bot added the stale *crickets chirp* label Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request maintenance This is for maintaining the repo stale *crickets chirp*
Projects
None yet
Development

No branches or pull requests

2 participants