kiudee / cs-ranking

Context-sensitive ranking and choice in Python with PyTorch
https://cs-ranking.readthedocs.io
Apache License 2.0
66 stars 15 forks source link

Check documentation style #124

Open timokau opened 4 years ago

timokau commented 4 years ago

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..

kiudee commented 4 years ago

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.