NA-MIC Project Weeks

Back to Projects List

Slicer documentation on ReadTheDocs

Key Investigators

• Jean-Christophe Fillion-Robin (Kitware)
• Andras Lasso (PerkLab)

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

• Discuss with Andras and agreed on:
  • migrating user documentation to readthedocs under a single directory
  • creating api.slicer.org with two set of pages: C++ and Python
  • using sphinx-api to automatically document wrapped classes
• Talked about associating Slicer extension with a 3d-slicer-extension GitHub topic.
• Sent an email to Ron for updating the Rons Rules For Tools.

Additional notes

• Slicer is now part of the awesome-healthcare list.
• See also What is an awesome list ?
• Should we create an awesome-medical-data list ?

Illustrations

• Associating Slicer extension with a 3d-slicer and 3d-slicer-extension topic:

Background and References

• Source code: https://github.com/Slicer/Slicer/pull/686