Developer Meetings/20170314

To Discuss

Maintenance of module and extension documentation. See http://slicer-devel.65872.n3.nabble.com/Module-list-in-documentation-not-updated-tt4038225.html

Currently, the script slicer_wiki_extension_module_listing.py is used to automatically create the listing of Slicer modules and extensions available on the Slicer wiki user documentation.

The creation of the listing is a two-step process:

• Step 1: On each factory (Linux, MacOSX, Windows):
  • the list of modules built in every extension is generated
  • Slicer is started to find out which modules can be loaded successfully into Slicer, the list of modules (as associated metadata) is then published into a github repository: https://github.com/Slicer/slicer-packages-metadata

• Step 2: Creation of consolidated listing of modules and extensions by downloading the metadata generated in the previous step and downloading the associated list of extension description files.

Discuss the hosting of doxygen files.

Conclusion

• Difficult to find information as it appears multiple time on the same page
• Middle column should be manually organized
• Automatic generation of subpage
• List of broken extension: Do not belong to the wiki: Write a test listing broken extensions, could be added to the developer tools
• One button, install all extensions, generate report

• Re-generate the listing to get baseline for manual maintenance
• Module name or extension have spaces

• Generate documentation from source code

• Extension listing -> point to the extension manager

• Gitbook:
  • different repo: advantage: can give access to more people
  • very limiting in formatting option
  • possible to copy image directly
  • Examples: https://lassoan.gitbooks.io/test-book/, https://qiicr.gitbooks.io/dcmqi-guide/

• RST
  • flexible
  • readthedocs