Opened 10 years ago

Last modified 8 years ago

#422 closed task

Enhance help (non model) documentation — at Version 6

Reported by: smk78 Owned by: smk78
Priority: critical Milestone: SasView 4.1.0
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

Description (last modified by butler)

The Sphinx help docs for Release 3.1 represent a porting of the pre-
existing HTML help docs to ReSTructured text.

Some restructuring has been conducted. Some (obvious!) equation errors
have been corrected. Some 'missing' content has been added.

The next steps are:

  • checking that the documentation actually reflects the current functionality of the program!
  • updating existing screenshots to match the current functionality of the program
  • adding additional screenshots

NOTE: Model documentation review is addressed separately in Ticket #19.

Change History (6)

comment:1 Changed 9 years ago by smk78

Also consider, as suggested by Richard, doing away with the 'top level' documentation menu. This would mean moving the links to the Model Functions and the Developer Documentation from Sphinx index.rst to the GUI Help dropdown and reorganising lower toctrees.

comment:2 Changed 9 years ago by smk78

Last suggestion dealt with under Ticket #436

comment:3 Changed 9 years ago by butler

  • Milestone changed from SasView Next Release +1 to SasView 4.0.0

comment:4 Changed 9 years ago by smk78

Need to add something about using Save Analysis and Save Project (suggestion ported from Ticket #20).

comment:5 Changed 9 years ago by smk78

Also see Ticket #33.

comment:6 Changed 9 years ago by butler

  • Description modified (diff)
  • Summary changed from Enhance help documentation to Enhance help (non model) documentation
Note: See TracTickets for help on using tickets.