Skip to content

InsightSoftwareConsortium/ITKDoxygen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ITKDoxygen

Overview

This dockerfile has been created to facilitate the creation of ITK Doxygen documentation in a reproducible way.

The documentation is built nightly on the current/latest ITK commit, and deployed to GitHub pages at: https://insightsoftwareconsortium.github.io/ITKDoxygen/

To create the the documentation locally, run the following commands:

docker build --build-arg TAG=v1.1.0 . -f Dockerfile -t itk-doxygen
docker build -f Dockerfile -t itk-doxygen .

export TAG=v1.2.0
docker run --env TAG --name itk-dox itk-doxygen

or

docker run \
  --env TAG \
  --mount type=bind,source=!ITK,destination=/work/ITK,readonly \
  --name itk-dox itk-doxygen

docker cp itk-dox:/ITKDoxygen.tar.gz SimpleITKDoxygen${TAG:+-${TAG}}.tar.gz
docker cp itk-dox:/ITKDoxygenXML.tar.gz SimpleITKDoxygenXML${TAG:+-${TAG}}.tar.gz
docker rm itk-dox

About

ITK Doxygen nightly built with GitHub Actions and published to GitHub Pages

Resources

Code of conduct

Stars

Watchers

Forks