MDAnalysis / cookiecutter-mdakit

Cookiecutter for Python packages based on MDAnalysis

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Generated test module will be included by default in sphinx docs

ianmkenney opened this issue · comments

I'm sure that, most of the time, developers don't care much about having user facing documentation for tests. With the recursive autodocs, these modules are included by default. We should be able to remove them with something like

autodoc_mock_imports = [
    '{{mykit}}.tests',
]

to conf.py.

Thanks for raising this @ianmkenney! sounds like a good solution -- could you please open a PR?