View Revisions: Issue #4697

Summary 0004697: Convert Slicer core modules documentation to RST
Revision 2019-06-13 00:29 by jcfr
Description

Update https://github.com/Slicer/Slicer/commits/rst-user-and-dev-guide adding documentation for the Slicer modules. Here is a selected list of modules for which we would like to have their documentation available first:

  • volumes
  • data: Reference data_loading_and_saving section
  • transform
  • volumerendering
  • segmentstatistics (check with @lassoan)
  • segmentation (check with @lassoan)
  • dicom
  • markups
  • models
  • tables
  • dataprobe

The idea is to copy adapt and improve corresponding documentation available on the wiki

Documentation can be build locally running make html from the Docs folder.

Important: when working on this issue, consider doing a separate clone of the Slicer source tree.

Revision 2019-06-13 00:27 by jcfr
Description

Update https://github.com/Slicer/Slicer/commits/rst-user-and-dev-guide adding documentation for the Slicer modules. Here is a selected list of modules for which we would like to have their documentation available first:

  • volumes
  • data
  • transform
  • volumerendering
  • segmentstatistics (check with @lassoan)
  • segmentation (check with @lassoan)
  • dicom
  • markups
  • models
  • tables
  • dataprobe

The idea is to copy adapt and improve corresponding documentation available on the wiki

Documentation can be build locally running make html from the Docs folder.

Important: when working on this issue, consider doing a separate clone of the Slicer source tree.

Revision 2019-06-13 00:25 by jcfr
Description

Update https://github.com/Slicer/Slicer/commits/rst-user-and-dev-guide adding documentation for the Slicer modules. Here is a selected list of modules for which we would like to have their documentation available first:

  • volumes
  • data
  • transform
  • volumerendering
  • segmentstatistics (check with @lassoan)
  • segmentation (check with @lassoan)
  • dicom
  • markups
  • models
  • tables
  • dataprobe

Documentation can be build locally running make html from the Docs folder.

Important: when working on this issue, consider doing a separate clone of the Slicer source tree.