cs-ranking icon indicating copy to clipboard operation
cs-ranking copied to clipboard

Check documentation style

Open timokau opened this issue 4 years ago • 1 comments

We have recently added some static analysis and formatting tools. One thing we are not checking for yet is inline documentation. There are some tools out there, for example pycodestyle. It seems like pylint has some doc checking functionality too.

I think it would be valuable to extend our static checks to the inline documentation. We already check stand-alone rst files with doc8..

timokau avatar May 29 '20 17:05 timokau

Now that we have tox running a test build of the documentation, we can think about letting it fail the build, when warnings occur. We should of course fix the warnings first.

kiudee avatar Sep 15 '20 11:09 kiudee