https://github.com/qupath/qupath-docs

QuPath documentation
https://github.com/qupath/qupath-docs

Last synced: 2 months ago
JSON representation

QuPath documentation

• Host: GitHub
• URL: https://github.com/qupath/qupath-docs
• Owner: qupath
• Created: 2020-02-14T16:24:24.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T10:42:05.000Z (9 months ago)
• Last Synced: 2024-04-08T10:48:51.776Z (9 months ago)
• Language: Python
• Homepage: http://qupath.readthedocs.io/
• Size: 59.7 MB
• Stars: 14
• Watchers: 5
• Forks: 21
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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:

```bash

python -m venv ./venv

. ./venv/bin/activate

```

or using conda/mamba:

```bash

conda env create -n qupath-docs python=3.12

conda activate qupath-docs

```

Then install the requirements for this repo:

```bash

pip install -r requirements.txt

```

You'll also need the command line tool `Make` (e.g., [GNU Make](https://www.gnu.org/software/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:

```bash

sphinx-autobuild . _build/html

```

## License

All original content here is shared under a Creative Commons license ([CC-BY 4.0](https://creativecommons.org/licenses/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](https://qupath.readthedocs.io/en/stable/docs/intro/acknowledgements.html).

> All this refers only to the documentation on this repo. 

> For license info about the QuPath *software*, see https://github.com/qupath/qupath