README.md

QuPath Docs

This contains the source for QuPath's documentation, hosted at https://qupath.readthedocs.io

Building locally

To build this locally, create a virtual environment, eg:

python -m venv ./venv
. ./venv/bin/activate

or using conda/mamba:

conda env create -n qupath-docs python=3.12
conda activate qupath-docs

Then install the requirements for this repo:

pip install -r requirements.txt

You'll also need the command line tool Make (e.g., GNU Make).

Then, you can run make to see available build options. make html will make the HTML version of the website, which is probably the most useful option. The built HTML files will be in _build/html, and can be opened in a web browser without running a local HTTP server.

Alternatively, you can install sphinx-autobuild and watchfiles into your virtual environment to run a HTTP server and have the HTML files automatically rebuilt when any changes are made:

sphinx-autobuild . _build/html

License

All original content here is shared under a Creative Commons license (CC-BY 4.0).

Here's the formal bit:

---

Except where otherwise noted, this website is licensed under a Creative Commons Attribution 4.0 International License.

---

In some places, the docs include public images from other sources, e.g. within screenshots. For download links and information about their licenses, see the Acknowledgements page.

All this refers only to the documentation on this repo. For license info about the QuPath software, see https://github.com/qupath/qupath