Edit this page

ProjectWeek

Back to Projects List

Slicer documentation on ReadTheDocs

Key Investigators

Project Description

Objective

  1. Finalize migration of user documentation from the wiki to ReadTheDocs. See https://github.com/Slicer/Slicer/pull/686 and http://slicer.readthedocs.io
  2. Discuss and work on migration of developer documentation.
  3. Setup api.slicer.org portal providing access to C++ classes documentation (generated using doxygen) and Python classes (generated using sphinx). See See https://www.slicer.org/wiki/Documentation/Labs/DocumentationImprovments#Documenting_Slicer_APIs
  4. Update Rons Rules For Tools to include testing and documentation.

Approach and Plan

  1. Review, discuss and implement proposed objectives

Progress and Next Steps

Additional notes

Illustrations

Generated documentation for VTK Wrapped class

Slicer topics Slicer extension topics

Background and References