Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Take exclude_patterns into account #271

Open
TobiasHolicki opened this issue Jan 5, 2025 · 2 comments
Open

Take exclude_patterns into account #271

TobiasHolicki opened this issue Jan 5, 2025 · 2 comments

Comments

@TobiasHolicki
Copy link

Hi,
I have a project with folder structure similar to

├── docs
├── src
└── tests
    ├── src
    └── submodules

Currently, I have set matlab_src_dir to the project's root directory, but then sphinxcontrib-matlabdomain returns several warnings related to functions from the imported submodules over which I have no control at all.

I think it could be nice to take sphinx's exclude_patterns into accound when scanning the matlab_src_dir for relevant files. At least that feels natural to me and seems to be not yet implemented.

@jzwysen
Copy link

jzwysen commented Jan 24, 2025

I would really like this feature as well. We are working with Matlab projects which creates a bunch of small files in a folder "resources" which takes time to process.

@apozharski
Copy link
Collaborator

Yep, I should have time this coming week to devote to work on this. Though if I am reading correctly and you mean this exclude_patterns I don't think it does what you think it does. I believe this excludes .rst files from being processed not files being processed via autodoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants