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

--post-build option #127

Open guideloom opened 1 year ago

guideloom commented 1 year ago

Context

sphinx-build doesn't copy "all" of the _static folder from the source target to the build target. This is a known issue: https://github.com/sphinx-doc/sphinx/issues/1810. I have some things that generated dynamically and are put into the _static tree. My "fix" is to add a small script to the Makefile that is run after the build, to copy/tar the _static tree from the source target to the build target. This works perfectly

However, autobuild doesn't run the Sphinx Makefile, so it's can't run that script. As far as I can tell there is no way for autobuild to do this. This results in an incomplete _static folder in the build target.

Proposal

As there exists a "--pre-build COMMAND" option, why not add a "--post-build COMMAND" option that works the same, but is run AFTER an autobuild run.

This would resolve my issue, and I'm sure others would find this useful as well.

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: