# ITKSphinxExamples

**Repository Path**: clust/ITKSphinxExamples

## Basic Information

- **Project Name**: ITKSphinxExamples
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-28
- **Last Updated**: 2024-08-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

ITK Sphinx Examples
===================

.. image:: https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/workflows/Build,%20test,%20publish/badge.svg?branch=master
   :target: https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/actions?query=workflow%3A%22Build%2C+test%2C+publish%22+branch%3Amaster

.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=shield
   :target: https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/blob/master/LICENSE


A set of cookbook examples for the Insight Toolkit, ITK_.

Download instructions
---------------------

Clone the repository using Git::

  $ git clone --recursive https://github.com/InsightSoftwareConsortium/ITKSphinxExamples.git


Build instructions
------------------

See the `build instructions in the documentation`_.

Features
--------

Implemented
^^^^^^^^^^^

- Stored and editable in Git_ version control.
- HTML / PDF / EPUB output.
- CTest unit testing.
- CMake ExternalData for binary data storage.
- Individual examples can be downloaded independently, and easily built/executed/hacked.
- Download the entire docs for offline viewing.
- Inline Doxygen class descriptions and links to Doxygen class documentation.
- Nightly generated Gitstats for contributors.
- Software quality dashboard.
- Index of examples that apply to given terms and classes.
- Quick search.
- Script to create a new examples from a template.
- GitHub community development.
- Selectable light/dark colorscheme.
- Online editing via GitHub.

Todo
^^^^

- See `Github Issues`_ for a complete list of actions to be performed, bugs, *etc.*

Build dependencies
------------------

Required
^^^^^^^^

- CMake_ ( >= 3.16.3 )
- ITK_  ( >= 5.3.0 )

Optional
^^^^^^^^

If building the documentation:

- Python_ ( >= 3.7 )
- Sphinx_
- Pandoc_
- nbsphinx_
- gnuplot_
- dvipng_ ( for rendered equations )
- imagemagick_

PDF generation requires a TeX distribution like `TeX Live`_ or MiKTeX_.

Development setup
------------------

Run the bash script ``SetupForDevelopment.sh``::

  $ ./Utilities/SetupForDevelopment.sh

.. _Breathe: https://github.com/michaeljones/breathe
.. _build instructions in the documentation: https://itk.org/ITKExamples/Documentation/Build/index.html
.. _CMake: https://cmake.org/
.. _Git: https://git-scm.com/
.. _ITK: https://itk.org/
.. _Sphinx: https://sphinx-doc.org/
.. _Github Issues: https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/issues
.. _Python: https://python.org/
.. _gnuplot: https://www.gnuplot.info/
.. _TeX Live: https://www.tug.org/texlive/
.. _MiKTeX: https://miktex.org/
.. _dvipng: https://sourceforge.net/projects/dvipng/
.. _Pandoc: https://pandoc.org/
.. _nbsphinx: https://nbsphinx.readthedocs.io/
.. _imagemagick: https://www.imagemagick.org/