{"id":28481640,"url":"https://github.com/insightsoftwareconsortium/itkdoxygen","last_synced_at":"2026-06-14T02:05:38.344Z","repository":{"id":37658563,"uuid":"472387390","full_name":"InsightSoftwareConsortium/ITKDoxygen","owner":"InsightSoftwareConsortium","description":"ITK Doxygen API documentation built nightly with GitHub Actions and published to ReadTheDocs, GitHub Pages","archived":false,"fork":false,"pushed_at":"2026-05-30T00:47:38.000Z","size":1089377,"stargazers_count":2,"open_issues_count":5,"forks_count":5,"subscribers_count":11,"default_branch":"main","last_synced_at":"2026-05-30T02:21:00.395Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.itk.org/projects/doxygen/","language":"Shell","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/InsightSoftwareConsortium.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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-03-21T15:01:21.000Z","updated_at":"2026-03-02T19:26:39.000Z","dependencies_parsed_at":"2023-11-17T03:29:15.204Z","dependency_job_id":"28fc23cd-9047-4ecc-b89e-fcce52793927","html_url":"https://github.com/InsightSoftwareConsortium/ITKDoxygen","commit_stats":{"total_commits":22,"total_committers":3,"mean_commits":7.333333333333333,"dds":0.2727272727272727,"last_synced_commit":"eb6f28d5d160b8acd430ea488dc4518fb1c71336"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/InsightSoftwareConsortium/ITKDoxygen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKDoxygen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKDoxygen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKDoxygen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKDoxygen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InsightSoftwareConsortium","download_url":"https://codeload.github.com/InsightSoftwareConsortium/ITKDoxygen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsightSoftwareConsortium%2FITKDoxygen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33844687,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-03T02:00:06.370Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-06-07T20:07:54.140Z","updated_at":"2026-06-03T02:01:34.484Z","avatar_url":"https://github.com/InsightSoftwareConsortium.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"ITKDoxygen\n==========\n\n[![][doxygen-img]][doxygen-link] [![][deployment-img]][deployment-link] [![][build-docker-img]][build-docker-link] [![][rtd-latest-img]][rtd-latest-link]\n\n[doxygen-img]: https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/workflows/Doxygen.yml/badge.svg\n[doxygen-link]: https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/workflows/Doxygen.yml\n\n[deployment-img]: https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/workflows/pages/pages-build-deployment/badge.svg\n[deployment-link]: https://insightsoftwareconsortium.github.io/ITKDoxygen/\n\n[build-docker-img]: https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/workflows/build-docker-image.yml/badge.svg\n[build-docker-link]: https://github.com/InsightSoftwareConsortium/ITKDoxygen/actions/workflows/build-docker-image.yml\n\n[rtd-latest-img]: https://readthedocs.org/projects/itkdoxygen/badge/?version=latest\n[rtd-latest-link]: https://app.readthedocs.org/projects/itkdoxygen/\n\nOverview\n--------\n\nThis Dockerfile has been created to facilitate the creation of\n[ITK](https://github.com/InsightSoftwareConsortium/ITK)\n[Doxygen](https://doxygen.nl/)\ndocumentation in a reproducible way.\n\nThe documentation is built nightly on the current/latest ITK commit,\nand deployed to GitHub pages at: https://insightsoftwareconsortium.github.io/ITKDoxygen/\nand to ReadTheDocs at: https://docs.itk.org/projects/doxygen/\n\nTo create the documentation locally, run the following commands:\n\n### 1. Clone the ITKDoxygen Repository\n\n### 2. Build the Docker Image\n```shell\ndocker build . -f Dockerfile -t itk-doxygen\n```\n\n### 3. Export TAG Environment Variable\nThe `TAG` environment variable is used to specify a filename for the tarballs \nto be copied from the Docker container to your local working directory (see \n[step 5](#5-copy-the-doxygen-documentation)).\nUseful for naming multiple versions of the documentation.\n\nHere we have set it to *alpha*, but you may change it as needed.\n```shell\nexport TAG=alpha\n```\n\n### 4. Run the Docker Container\n#### Option 1: Using the Latest ITK Repository\n```shell\ndocker run --env TAG --name itk-dox itk-doxygen\n```\n\n#### Option 2: Using a Local ITK Repository\nIf you want to build documentation from a local ITK repository, \nremove the `readonly` parameter from the mount command and \nspecify an absolute path to the aforementioned repository.\n```shell\ndocker run \\\n  --env TAG \\\n  --mount type=bind,source=/path/to/your/clone,destination=/work/ITK,readonly \\\n  --name itk-dox itk-doxygen\n```\n\u003e **Note:** Both these commands may take a while to complete\n\n### 5. Copy the Doxygen Documentation\n\nThe following commands will copy the tarballs from the\nDocker container to your local working directory.\n```shell\ndocker cp itk-dox:/ITKDoxygen.tar.gz ITKDoxygen${TAG:+-${TAG}}.tar.gz\ndocker cp itk-dox:/ITKDoxygenXML.tar.gz ITKDoxygenXML${TAG:+-${TAG}}.tar.gz\n\n# Remove the Docker container after copying the tarballs\ndocker rm itk-dox\n```\n\n### 6. Extract the Doxygen Documentation\nUntar these tarballs to extract and verify the Doxygen documentation. \nThe `ITKDoxygen` tarball contains the HTML documentation,\nwhile the `ITKDoxygenXML` tarball contains the XML documentation.\n\n```shell\ntar -xzf ITKDoxygen${TAG:+-${TAG}}.tar.gz\ntar -xzf ITKDoxygenXML${TAG:+-${TAG}}.tar.gz\n```\n\nYou may now view the Doxygen documentation by opening the `html/index.html` file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsoftwareconsortium%2Fitkdoxygen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finsightsoftwareconsortium%2Fitkdoxygen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsoftwareconsortium%2Fitkdoxygen/lists"}