search

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
523 stars 75 forks source link

ENH: Allow passing relative paths to --ignore #110

Closed omad closed 1 year ago

omad commented 3 years ago

For the longest time I've wondered why sphinx-autobuild would get stuck in an infinite rebuild loop, even though I'd ignored the directories I needed too. Turns out, --ignore only worked with absolute paths, which seems like an odd thing to work for anyone.

This allows either relative or absolute paths, and passes globs through unharmed.

welcome[bot] commented 3 years ago

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

jorisvandenbossche commented 2 years ago

This would indeed be very useful. For ignoring some generated autosummary files, and for using sphinx-autobuild from a sphinx Makefile, I am currently using --ignore $(shell pwd)/source/generated/*.rst as a workaround.

moorepants commented 2 years ago

This confused me, so +1 for relative paths.

welcome[bot] commented 1 year ago

Congrats on your first merged pull request in this project! :tada: congrats
Thank you for contributing, we are very proud of you! :heart: