readthedocs / readthedocs/sphinx-autoapi
Excluding directories
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how autoapi_dirs is traversed and how autoapi_ignore is applied to filenames. Exclude matching directories before descending into them, and verify that a directory such as docs, including its env contents, is not processed while other files remain discoverable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100