Skip to content

carlocastoldi/qupath-docs

 
 

Repository files navigation

QuPath Docs

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

Building locally

To build this locally, you should first install (possibly in a venv):

  • sphinx-build
  • sphinx_rtd_theme
  • myst_parser
  • readthedocs-sphinx-search

As well as 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.

License

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

Here's the formal bit:


Creative Commons Licence
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

About

QuPath documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 83.3%
  • Batchfile 8.0%
  • Makefile 6.7%
  • CSS 2.0%