Changeset 1709 for sphinxdocs/build/html/_modules/config_example.html

Timestamp:

Mar 14, 2015 5:35:03 PM (8 years ago)

Author:

toby

Message:

change sphinx docs links; rebuild & fixing minor formatting

File:

• sphinxdocs/build/html/_modules/config_example.html (modified) (2 diffs)

sphinxdocs/build/html/_modules/config_example.html

@@ -66 +66 @@
 <span class="sd">provide the default behavior if the file is not present or if any configuration</span>
 <span class="sd">variable is not set, but please do place a docstring here for every used</span>
-<span class="sd">config variable explaining what it does. </span>
+<span class="sd">config variable explaining what it does. Access these variables using</span>
+<span class="sd">:func:`GSASIIpath.GetConfigValue`.</span>
+<span class="sd">&#39;&#39;&#39;</span>
+
+<span class="n">debug</span> <span class="o">=</span> <span class="bp">False</span>
+<span class="sd">&#39;&#39;&#39;Set to True to turn on debugging mode. This enables use of IPython on </span>
+<span class="sd">exceptions and on calls to :func:`GSASIIpath.IPyBreak`. Calls to</span>
+<span class="sd">:func:`GSASIIpath.pdbBreak` will invoke pdb at that location.</span>
+<span class="sd">If debug is false calls to :func:`GSASIIpath.IPyBreak` and</span>
+<span class="sd">:func:`GSASIIpath.pdbBreak` are ignored.</span>
 <span class="sd">&#39;&#39;&#39;</span>
 
@@ -74 +83 @@
 <span class="n">logging_debug</span> <span class="o">=</span> <span class="bp">None</span>
 <span class="s">&#39;Set to True to enable debug for logging&#39;</span>
+
+<span class="n">Help_mode</span> <span class="o">=</span> <span class="bp">None</span>
+<span class="s">&#39;Set to &quot;internal&quot; to use a Python-based web viewer rather than a web browser&#39;</span>
+
+<span class="n">Tutorial_location</span> <span class="o">=</span> <span class="bp">None</span>
+<span class="sd">&#39;&#39;&#39;Change this to place tutorials by in a different spot. If None, this defaults to</span>
+<span class="sd">the location where GSAS-II is loaded GSASIIpath.path2GSAS2. For installations where</span>
+<span class="sd">G2 is installed by an administrator, it is a good idea to use something like this::</span>
+
+<span class="sd">    import os.path</span>
+<span class="sd">    Tutorial_location = os.path.join(os.path.expanduser(&#39;~&#39;),&#39;G2tutorials&#39;)</span>
+
+<span class="sd">This will allow users to download tutorial files into their own file space.</span>
+<span class="sd">&#39;&#39;&#39;</span>
 </pre></div>