Changes between Version 2 and Version 3 of CodeCampIII/ScheduleAndWork/DocumentationWP


Ignore:
Timestamp:
Feb 14, 2015 8:26:16 AM (10 years ago)
Author:
butler
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • CodeCampIII/ScheduleAndWork/DocumentationWP

    v2 v3  
    11== Documentation Tasks == 
     2One of the key priorities for long term sustainability and user support and uptake is proper documentation.  Currently (as of 3.0) most of the developer docs which are in the files as docstrings do not get scrapped properly.  Moreover the docs strings are extremely limited and sometimes unhelpful.  From  
    23 
    3 Tasks 
    4 * copy all remaining documentation into ReST files (except for PDF tutorial for now which will need rewriting) - S. King (lead) and P. Butler 
    5 * convert eqations from images to TeX - Peter Parker to do first then Paul Butler 
    6 * Split the models documentation -- ask new models peope 
    7 * Integrate into GUI - Paul Butler 
    84 
    95[[TicketQuery(workpackage=SasView Documentation)]] 
    106 
     7Tasks 
     8* Get Sphinx to properly build all the docstrings and produce user documentation pushed to website at every build - <b>DONE</b> 
     9* Clean up and add developer documentation to modules - .... 
     10* Get Sphinx to collect all RST documentation in various folders and create user documentation pushed to website on every build AND available in SasView application directly - DONE 
     11* copy all remaining documentation into ReST files (except for PDF tutorial for now which will need rewriting) - S. King (lead) and P. Butler 
     12* convert eqations from images to TeX - Peter Parker to do first then Paul Butler 
     13* Split the models documentation -- wait to see how new model structure works 
     14* Integrate into GUI - Paul Butler 
    1115 
    1216== Developers ==