Closed gvwilson closed 9 months ago
The first "error message" is just a warning; CPython issue bpo27578, PR https://github.com/python/cpython/pull/20809 (please upvote).
__pdoc__ = {'tests': False}
inside mwe.tests
is obviously wrong (results in the path mwe.tests.tests
). But __pdoc__ = {'tests': False}
in the main mwe/__init__.py absoltely should work. If it doesn't, it might be a bug related to https://github.com/pdoc3/pdoc/issues/306 or some other issue. :grimacing: If you would take the time to investigate it, that would certainly be appreciated! :sweat_smile:
Another workaround that might work is to prefix tests dir with an underscore (i.e. _tests).
I want
pdoc3
to skip everything in my project's thetests
directory, but even after reading #99 I am unable to get it to do so. Steps taken:Create new directory
mwe
andcd
into it.Create
./main.py
with:Create
./tests
directory.Create
./tests/test.py
with:pdoc --force --html .
to generate docs:./tests/__init__.py
, re-runpdoc --force --html .
, get error message:./tests/__init__.py
produces a different error message:
__init__.py
file in the project's root directory with this content produces the same error message:./__init__.py
to containmwe.tests
as shown below also produces this error message:I'd be grateful for the correct incantation (or if one doesn't exist, I'd be happy to PR a
--ignore dir [dir]
option).