Ignore:
Timestamp:
Oct 24, 2011 2:02:30 PM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
70ecd530
Parents:
a4f04f2
Message:

updates docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • sansdataloader/docs/sphinx/html/api/readers/associations.html

    rfc5d49e3 r7247844  
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
    55 
     6 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    78  <head> 
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>associations &mdash; DataLoader v0.1.0 documentation</title> 
     11    <title>associations &mdash; DataLoader 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
     
    2326    <script type="text/javascript" src="../../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../../_static/doctools.js"></script> 
    25     <link rel="top" title="DataLoader v0.1.0 documentation" href="../../index.html" /> 
     28    <link rel="top" title="DataLoader 0.1.0 documentation" href="../../index.html" /> 
    2629    <link rel="up" title="Readers" href="index.html" /> 
    2730    <link rel="next" title="cansas_reader" href="cansas_reader.html" /> 
     
    4447          <a href="ascii_reader.html" title="ascii_reader" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Readers</a> &raquo;</li>  
    4851      </ul> 
     
    5659  <div class="section" id="associations"> 
    5760<h1>associations<a class="headerlink" href="#associations" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-DataLoader.readers.associations"> 
    59 <span id="dataloader-readers-associations"></span><h2><a class="reference internal" href="#module-DataLoader.readers.associations" title="DataLoader.readers.associations"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.associations</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.associations" title="Permalink to this headline">¶</a></h2> 
    60 <p>Module to associate default readers to file extensions. 
     61<div class="section" id="sans-dataloader-readers-associations"> 
     62<h2><a class="reference internal" href="#module-sans.dataloader.readers.associations" title="sans.dataloader.readers.associations"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.associations</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-associations" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.dataloader.readers.associations"></span><p>Module to associate default readers to file extensions. 
    6164The module reads an xml file to get the readers for each file extension. 
    6265The readers are tried in order they appear when reading a file.</p> 
    6366<dl class="function"> 
    64 <dt id="DataLoader.readers.associations.read_associations"> 
    65 <tt class="descclassname">DataLoader.readers.associations.</tt><tt class="descname">read_associations</tt><big>(</big><em>loader</em>, <em>settings='defaults.xml'</em><big>)</big><a class="headerlink" href="#DataLoader.readers.associations.read_associations" title="Permalink to this definition">¶</a></dt> 
     67<dt id="sans.dataloader.readers.associations.read_associations"> 
     68<tt class="descclassname">sans.dataloader.readers.associations.</tt><tt class="descname">read_associations</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.associations.read_associations" title="Permalink to this definition">¶</a></dt> 
    6669<dd><p>Read the specified settings file to associate 
    6770default readers to file extension.</p> 
     
    7073<col class="field-body" /> 
    7174<tbody valign="top"> 
    72 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     75<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    7376<li><strong>loader</strong> &#8211; Loader object</li> 
    7477<li><strong>settings</strong> &#8211; path to the XML settings file [string]</li> 
     
    8184 
    8285<dl class="function"> 
    83 <dt id="DataLoader.readers.associations.register_readers"> 
    84 <tt class="descclassname">DataLoader.readers.associations.</tt><tt class="descname">register_readers</tt><big>(</big><em>registry_function</em><big>)</big><a class="headerlink" href="#DataLoader.readers.associations.register_readers" title="Permalink to this definition">¶</a></dt> 
     86<dt id="sans.dataloader.readers.associations.register_readers"> 
     87<tt class="descclassname">sans.dataloader.readers.associations.</tt><tt class="descname">register_readers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.associations.register_readers" title="Permalink to this definition">¶</a></dt> 
    8588<dd><p>Function called by the registry/loader object to register 
    8689all default readers using a call back function.</p> 
     
    8992<col class="field-body" /> 
    9093<tbody valign="top"> 
    91 <tr class="field"><th class="field-name">Warning :</th><td class="field-body">this method is now obsolete</td> 
     94<tr class="field-odd field"><th class="field-name">Warning :</th><td class="field-body">this method is now obsolete</td> 
    9295</tr> 
    93 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>registry_function</strong> &#8211; function to be called to register each reader</td> 
     96<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><strong>registry_function</strong> &#8211; function to be called to register each reader</td> 
    9497</tr> 
    9598</tbody> 
     
    109112  <ul> 
    110113<li><a class="reference internal" href="#">associations</a><ul> 
    111 <li><a class="reference internal" href="#module-DataLoader.readers.associations"><tt class="docutils literal"><span class="pre">DataLoader.readers.associations</span></tt></a></li> 
     114<li><a class="reference internal" href="#sans-dataloader-readers-associations"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.associations</span></tt></a></li> 
    112115</ul> 
    113116</li> 
     
    128131  <h3>Quick search</h3> 
    129132    <form class="search" action="../../search.html" method="get"> 
    130       <input type="text" name="q" size="18" /> 
     133      <input type="text" name="q" /> 
    131134      <input type="submit" value="Go" /> 
    132135      <input type="hidden" name="check_keywords" value="yes" /> 
     
    157160          <a href="ascii_reader.html" title="ascii_reader" 
    158161             >previous</a> |</li> 
    159         <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li> 
     162        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li> 
    160163          <li><a href="index.html" >Readers</a> &raquo;</li>  
    161164      </ul> 
     
    163166    <div class="footer"> 
    164167        &copy; Copyright 2010, sans group. 
    165       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     168      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    166169    </div> 
    167170  </body> 
Note: See TracChangeset for help on using the changeset viewer.