a5kin / xentica

GPU-accelerated engine for multi-dimensional cellular automata

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Adopt docstrings coverage tool

a5kin opened this issue · comments

We need some tool to monitor project's coverage by docstrings, and possibly the quality of docstrings: arguments coverage etc. Maybe it would be done by some autodoc tool, maybe by pylint. In the worst case, we could write our own solution. Let investigate this.

It seems, there is no good tool to monitor docstrings coverage. Let just turn tech writer paranoid mode on by pip install flake8_docstrings and keep each and every thing documented from now on.

Sphinx build files are created, docs are integrated with Readthedocs.io