search

qupath / qupath-docs

QuPath documentation
http://qupath.readthedocs.io/
17 stars 22 forks source link

Update README.md #108

Closed alanocallaghan closed 7 months ago

alanocallaghan commented 7 months ago

Resolves #54

alanocallaghan commented 7 months ago

Added sphinx-autobuild instructions, feel free to test

petebankhead commented 7 months ago

I'm not sure if we want these in the requirements.txt, since they aren't required - why not just leave it up to the user if they want to install sphinx-autobuild on their own environment?

petebankhead commented 7 months ago

The requirements.txt is really intended for readthedocs: https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html#use-a-requirements-file-for-python-dependencies

Although it doesn't currently specify a sphinx version... I suspect it was written far enough in the past that the readthedocs docs could have changed in the interim, and we are some way off best practice.

alanocallaghan commented 7 months ago

Yeah fair enough, removed from reqs but left in the readme