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

Ignore `autosummary` generated files to detect changes #154

Open plutonium-239 opened 2 months ago

plutonium-239 commented 2 months ago

Hello, I use autosummary with basic templating to create pages for each class in a submodule. Using s[hinx-autobuild has definitely made my life easier! However, on making changes to the template, all autosummary generated pages are re-generated, thus causing sphinx-autobuild to build the docs multiple times, one for each generated file.

Is there a way to detect which files are generated by autosummary/other related extensions and not watch them for changes?

I can also contribute to this, I just want to know in which direction to look.

AVHopp commented 1 month ago

I would also be very interested in this, since I have the problem of sphinx-autobuild repeatedly re-building the documentation on a single change that is made to the source code repository that I watch. To me, it feels like this might happen due to the same issue since I also use autosummary and sphinx-autobuild always claims to find changes.