Ignore entire package / directory?

[adrian-chang]

Hello there,

I actually download my dependencies locally into a subfolder within my package similar to something like this.

package/
     __init__.py
     code.py
     downloaded_modules/
           requests/
           ...

Is there any way to effectively ignore downloaded_modules?

Thanks

[kernc]

Exclude items using __pdoc__ dict.

Duplicate of #12.

[adrian-chang]

Hello, I've tried using __pdoc__["module"] = False multiple times.

For example, in the solution above I would do something like __pdoc__["package.downloaded_modules"] = False in __init__.py, however, the CLI tools seems to still traverse the "downlaoded_modules" directory which then causes a problem as not everything in that "downloaded_modules" folder is not python code.

Is there something I'm missing?

More concrete package structure where the tool fails where in this case, I explictly put in tools/__init__.py __pdoc__ = {"cli.tools.downloaded_modules": False}.

cli/
  __init__.py
  tools/
    __init__.py
    tool_one.py
    downloaded_modules/
           requests-1.8.0.pkg/
           boostrap1.0.0.pkg/
          ....

[kernc]

Yeah, I'm thinking pdoc shouldn't even traverse ignored modules lest havoc. 😄

It should probably also follow .gitignore so that pointless in-tree directories needn't even be listed in __pdoc__.