docs: Live reload with sphinx-autobuild

[dimaqq]

• it works 🎉
• sphinx-autobuild was already included in pyproject.toml, was there already a way to rebuild on change?
• let's paint that bike shed and decide on the tox -e <name> for this

[dimaqq]

WDYT folks, do we need it or not?

[benhoyt]

I'm not opposed to it. I think I would have used this when working on docs(trings). docs-live is okay. Or maybe docs-server?

[tonyandrewmeyer]

I'm not opposed to this, but I doubt I would use it. I tend to write, then do tox -e docs and read the output to make sure I didn't mess up a reference etc and then refresh the page in my browser. It doesn't seem like this would change that workflow enough that I would make use of it. But again, not opposed to it if it would be useful for others.

docs-live-reload?

[dimaqq]

I've addressed the code comments, the change is smaller now.
I think it's good to go :)

[tonyandrewmeyer]

I still don't have any objection to this, but I also don't really see its value. I tried it out, thinking that I could live see any changes I made to the docs, but that isn't the case, because the docs are in ops/ and it's watching for changes in docs/. So this would seem to only be useful when making changes to the custom config or the index, which are both pretty rare in my experience.

Could you please update the PR description to better explain what the PR does? Then it can also be the details for the commit to main, and they nicely match for future looking back.

[benhoyt]

the docs are in ops/ and it's watching for changes in docs/. So this would seem to only be useful when making changes to the custom config or the index, which are both pretty rare in my experience.

Oooh, I'd missed that. Yeah, I don't think it's worth it then. Can it watch ops/ as well?