sphinx-doc / sphinx-autobuild

Watch a Sphinx directory and rebuild the documentation when a change is detected. Also includes a hot-reload web server.
MIT License
550 stars 83 forks source link

Use sphinx's `exclude_patterns` for ignore pattern #131

Open LecrisUT opened 1 year ago

LecrisUT commented 1 year ago

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[bot] commented 1 year ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

LecrisUT commented 1 year ago

(Is there a way to have EBP bot not have amnesia across multiple projects?)

koalp commented 12 months ago

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 ?)