{"id":18456672,"url":"https://github.com/qupath/qupath-docs","last_synced_at":"2025-04-08T04:35:14.954Z","repository":{"id":43008371,"uuid":"240551172","full_name":"qupath/qupath-docs","owner":"qupath","description":"QuPath documentation","archived":false,"fork":false,"pushed_at":"2024-04-08T10:42:05.000Z","size":62652,"stargazers_count":14,"open_issues_count":10,"forks_count":21,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-04-08T10:48:51.776Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://qupath.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qupath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-02-14T16:24:24.000Z","updated_at":"2024-04-15T14:03:40.897Z","dependencies_parsed_at":"2024-04-08T10:55:09.166Z","dependency_job_id":null,"html_url":"https://github.com/qupath/qupath-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qupath%2Fqupath-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qupath%2Fqupath-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qupath%2Fqupath-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qupath%2Fqupath-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qupath","download_url":"https://codeload.github.com/qupath/qupath-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247779795,"owners_count":20994569,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T08:12:24.953Z","updated_at":"2025-04-08T04:35:09.944Z","avatar_url":"https://github.com/qupath.png","language":"Python","readme":"# QuPath Docs\n\nThis contains the source for QuPath's documentation, hosted at https://qupath.readthedocs.io\n\n## Building locally\n\nTo build this locally, create a virtual environment, eg:\n\n```bash\npython -m venv ./venv\n. ./venv/bin/activate\n```\n\nor using conda/mamba:\n\n```bash\nconda env create -n qupath-docs python=3.12\nconda activate qupath-docs\n```\n\nThen install the requirements for this repo:\n\n```bash\npip install -r requirements.txt\n```\n\nYou'll also need the command line tool `Make` (e.g., [GNU Make](https://www.gnu.org/software/make/)).\n\nThen, you can run `make` to see available build options.\n`make html` will make the HTML version of the website, which is probably the\nmost useful option. The built HTML files will be in `_build/html`, and can\nbe opened in a web browser without running a local HTTP server.\n\nAlternatively, you can install `sphinx-autobuild` and `watchfiles`\ninto your virtual environment to run a HTTP server and have the HTML files\nautomatically rebuilt when any changes are made:\n\n```bash\nsphinx-autobuild . _build/html\n```\n\n## License\n\nAll original content here is shared under a Creative Commons license ([CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/)).\n\nHere's the formal bit:\n\n---\n\n\u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by/4.0/\"\u003e\u003cimg alt=\"Creative Commons Licence\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by/4.0/88x31.png\" /\u003e\u003c/a\u003e\u003cbr /\u003eExcept where otherwise noted, this website is licensed under a \u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by/4.0/\"\u003eCreative Commons Attribution 4.0 International License\u003c/a\u003e.\n\n---\n\nIn some places, the docs include public images from other sources, e.g. within screenshots.\nFor download links and information about their licenses, see [the Acknowledgements page](https://qupath.readthedocs.io/en/stable/docs/intro/acknowledgements.html).\n\n\u003e All this refers only to the documentation on this repo. \n\u003e For license info about the QuPath *software*, see https://github.com/qupath/qupath\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqupath%2Fqupath-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqupath%2Fqupath-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqupath%2Fqupath-docs/lists"}