Changeset 3187 for trunk/GSASIIctrlGUI.py

Timestamp:

Dec 10, 2017 10:14:04 AM (5 years ago)

Author:

toby

Message:

misc docs cleanups; add 1-ID metadata reader & new config variable

File:

• trunk/GSASIIctrlGUI.py (modified) (1 diff)

trunk/GSASIIctrlGUI.py

@@ -4559 +4559 @@
     #['ExampleDir', 'ExamplePage.html', 'Example Tutorial Title'],
     )
+'''A catalog of GSAS-II tutorials with headings. This is the master list of GSAS-II tutorials and must be updated when tutorials are
+added. Each item has either one or three items. 
+Titles are single item in a list or tuple. Tutorials have three items: (a) the name of the directory,
+(b) the name of the web page and (c) a title for the tutorial. 
+Tutorials that depend on a previous tutorial being completed should have the title for
+the tutorial indented by five spaces.
+
+Note that :data:`tutorialCatalog` is generated from this tuple. 
+Also see :mod:`makeTutorial` which is used to read this and create a web page.
+'''
+
+#A catalog of GSAS-II tutorials generated from the table in :data:`tutorialIndex`
 tutorialCatalog = [l for l in tutorialIndex if len(l) == 3]