zarr-python icon indicating copy to clipboard operation
zarr-python copied to clipboard

Add sphinx-autobuild to documentation build options

Open DON-BRAN opened this issue 3 years ago • 3 comments

I believe it will be great to have sphinx-autobuild added as a build option for the documentation. This can help avoid constant manual builds during development.

What are your thoughts please? 🤓

DON-BRAN avatar Nov 02 '22 19:11 DON-BRAN

Are you suggesting adding an optional requirement? Strictly speaking, anyone could already install the package and use it locally now, right?

joshmoore avatar Nov 03 '22 08:11 joshmoore

Are you suggesting adding an optional requirement? Strictly speaking, anyone could already install the package and use it locally now, right?

Yes that's right anyone can install the package and use locally. Was just wondering if it could be shipped in the documentation build script to reduce the setup complexity for others

DON-BRAN avatar Nov 04 '22 08:11 DON-BRAN

Guess I don't know exactly what that would look like, but happy to consider it.

joshmoore avatar Nov 04 '22 11:11 joshmoore

This works today using hatch:

hatch --env docs run serve

jhamman avatar Jan 10 '25 06:01 jhamman