Excluding directories

[evildmp]

AutoAPI makes the reasonable assumption that one's directory structure will look like:

    mypackage/
    ├── docs directory
    │   ├── ...
    │   └── ...
    ├── code directory
    │   ├── ...
    │   └── ...
    └── ...

I have at least one structure however that looks like:

    mypackage/
    ├── docs directory
    │   ├── ...
    │   └── ...
    ├── simple code file
    ├── another simple code file
    └── ...

Using autoapi_dirs = ['..'] means that it descends back into docs where it also finds an env and gobbles up everything it finds in there. Then I get a Relative import with too many levels (and it spends a long time processing the contents of the env too).

Unfortunately autoapi_ignore only appears to work on filenames, not directories.

I'd like a way to be able to exclude all of some arbitrary directory, in my case, /docs

[rexwangcc]

Ran into a similar issue and I tried something like *vendor* which did the trick (ignoring files under vendor/) for me, just FYI 😄

[AWhetter]

To any first time contributors looking to resolve this issue, we can filter the list of directories here:

sphinx-autoapi/autoapi/mappers/base.py

Line 239 in 17ffa2d

for root, _, filenames in os.walk(_dir):

[rajkaramchedu]

This is a little beyond my coding skills, but I could really use a better way to exclude files and directories. The trouble with *somekeyword* is it will exclude all the files that match it, including the ones in the directory that I am including.
Use case: If I am editing docstrings in a large Python library, I prefer the local builds go faster, and for that I need to exclude a lot of stuff.

[bgmeulem]

First time contributor here! The PR that i linked should resolve this. Could anyone review or approve the test runs?