NA-MIC Project Weeks

Back to Projects List

Slicer documentation on ReadTheDocs

Key Investigators

• Jean-Christophe Fillion-Robin (Kitware Inc., USA)
• Andras Lasso (Queen’s University, Canada)

Project Description

We will continue the work initiated during the 27th Project Week.

Ultimately, all modules would have their documentation managed along side the Slicer source code. For example, see Segment Editor documentation.

Objective

1. Streamline maintenance of Slicer user and developer documentation
2. Ensure Slicer documentation updates are reviewed along side feature integration
3. Document KitwareMedical/SlicerCustomAppTemplate
4. Discuss strategy to manage translation files

Approach and Plan

1. Finalize migration of Slicer user documentation from the wiki to ReadTheDocs. See https://github.com/Slicer/Slicer/pull/686 and http://slicer.readthedocs.io
2. Document process to install Qt5 and build Slicer using it
3. Discuss and work on migration of developer documentation.
4. Setup documentation of KitwareMedical/SlicerCustomAppTemplate on readthedocs
5. Create sphinx-cmake python package. A sphinx documentation framework plugin enabling project to easily document their build system.

Progress and Next Steps

• Slicer wiki updated to explain how to install Qt5 and build slicer
• Instructions for Linux, macOS and Windows updates
• Added step-by-step guide with screenshot explaining how to install Qt on windows

Illustrations

Background and References

• Source code: https://github.com/Slicer/Slicer/pull/686
• 27th Project week page: https://github.com/NA-MIC/ProjectWeek/tree/master/PW27_2018_Boston/Projects/SlicerReadTheDocs