python-project-template icon indicating copy to clipboard operation
python-project-template copied to clipboard
verified publisher icon lincc-frameworks

Update the hydrated project readme to include .setup-dev.sh

Open drewoldag opened this issue 1 year ago • 0 comments

Currently the README that is generated for a new project has a Dev Guide section that includes instructions for configuring pre-commit and installing pandoc. But it should include running .setup-dev.sh since that will also install all the sphinx requirements as well.

Otherwise the pre-commit will fail if auto doc generation is included.

drewoldag avatar Aug 08 '24 16:08 drewoldag