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

Optional argument to run script / bash cmd on rebuild event #69

Closed HarisGodil closed 3 years ago

HarisGodil commented 5 years ago

My use case: I have a script which I currently run before sphinx-build that automatically places automodule directives in the relevant files, so that my test documentation will pull in the appropriate docstrings.

Having the ability to add --run ./link_tests would allow me to keep all the functionality I'm currently getting in my workflow of manually rebuilding

I'm planning on working on this (at some point next week), but I'm still posting this as an issue just incase anyone has an objection to this functionality or has some feedback / additional functionality wants.

pradyunsg commented 3 years ago

Sounds like a reasonable request!