Changeset 3187 for trunk/makeTutorial.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/makeTutorial.py (modified) (1 diff)

trunk/makeTutorial.py

@@ -1 @@
-# create an HTML page from the tutorials in GSASIIctrlGUI.tutorialCatalog
+# -*- coding: utf-8 -*-
+#makeTutorial.py
+########### SVN repository information ###################
+# $Date: $
+# $Author: toby $
+# $Revision: 3167 $
+# $URL: $
+# $Id: $
+########### SVN repository information ###################
+'''
+*makeTutorial: Make Tutorial Web Page*
+---------------------------------------------
+
+Creates an HTML page (``GSASII/help/Tutorials.html``) listing all the tutorials in
+:data:`GSASIIctrlGUI.tutorialIndex`. Run this after adding a new tutorial to that
+index.
+'''
 
 from __future__ import print_function