Contribute

The ITK Sphinx Examples are stored in the Git distributed version control system, and the mainline repository can be found at ITK Sphinx Examples repository. Files in the repository can be edited via the typical text editor / version control workflow used when modifying source code.

Examples code can be written in the C++ or Python programming languages. Documentation for the examples is writted in reStructuredText / Sphinx. Sphinx is a build system that uses the reStructuredText syntax with additional capabilies, such as multi-document projects and rendering of LaTeX-style equations. A good reference for the easy-to-learn reStructuredText syntax is the Quick reStructuredText guide.

There are a variety of ways to take part in the ITK Sphinx Examples project. All facets are important to the success of the project.

• Contribute with Git
  • Clone the repository and setup for development
  • Modifying an existing example
  • Create a new example
• How to write a new example
  • General guidelines
  • Directory placement
  • Title
  • Index entries
  • Synopsis
  • Code
  • Results
  • Classes demonstrated
• Upload Binary Data
  • Motivation
  • Prerequisites
  • Upload Via the Web Interface
  • Upload Via CMake and Node.js CLI
• Peer review with GitHub
  • Peer review duty
  • Review comments
  • Review ratings
• Submit results to CDash
  • Experimental submission
  • Nightly submission