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

Use sphinx's exclude_patterns for ignore pattern #131

Open
LecrisUT opened this issue Jun 27, 2023 · 3 comments
Open

Use sphinx's exclude_patterns for ignore pattern #131

LecrisUT opened this issue Jun 27, 2023 · 3 comments

Comments

@LecrisUT
Copy link

Context

An example case is when having doxygen source folder generated in the top-level sphinx source directory. In that case the users puts in the doxygen folder in exclude_patterns. By default this is not in the autobuild ignore, so it will just loop as the doxygen-sphinx builder constantly re-generates the doxygen source.

Proposal

Add the exclude_patterns from sphinx by default in the autobuild ignore (expanding with the conf.py path). The files there are never meant to be source files that sphinx uses, so it should be safe.

Having this as a default would make the doxygen configuration portable under the vcs, so the user wouldn't have to guess what flags to use for autobuild

Tasks and updates

No response

@welcome

This comment was marked as off-topic.

@LecrisUT

This comment was marked as off-topic.

@koalp
Copy link

koalp commented Nov 10, 2023

Hello. I use sphinx-autoapi, Unfortunately when I activate autoapi_keep_files for faster builds, files are stored in the source directory and sphinx-autobuild detects new files after each build and loops.

Is there a workaround to exclude files to avoid rebuild-loop ? (or should I use the merge request patch ?)

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

No branches or pull requests

2 participants