Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-updates > by-pkgid > b9a6a1b9f2781444d2917afd8e4421ab > files > 753

ipython-doc-2.3.0-2.2.mga5.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Module: nbconvert.exporters.export &mdash; IPython 2.3.0 documentation</title>
    
    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../',
        VERSION:     '2.3.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../../_static/jquery.js"></script>
    <script type="text/javascript" src="../../_static/underscore.js"></script>
    <script type="text/javascript" src="../../_static/doctools.js"></script>
    <link rel="top" title="IPython 2.3.0 documentation" href="../../index.html" />
    <link rel="up" title="The IPython API" href="../index.html" />
    <link rel="next" title="Module: nbconvert.exporters.exporter" href="IPython.nbconvert.exporters.exporter.html" />
    <link rel="prev" title="Module: lib.security" href="IPython.lib.security.html" /> 
  </head>
  <body>

<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="http://ipython.org/"><img src="../../_static/logo.png" border="0" alt="IPython Documentation"/></a>
</div>

    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="IPython.nbconvert.exporters.exporter.html" title="Module: nbconvert.exporters.exporter"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="IPython.lib.security.html" title="Module: lib.security"
             accesskey="P">previous</a> |</li>
        <li><a href="http://ipython.org">home</a>|&nbsp;</li>
        <li><a href="../../search.html">search</a>|&nbsp;</li>
       <li><a href="../../index.html">documentation </a> &raquo;</li>

          <li><a href="../index.html" accesskey="U">The IPython API</a> &raquo;</li> 
      </ul>
    </div>

      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Module: <tt class="docutils literal"><span class="pre">nbconvert.exporters.export</span></tt></a><ul>
<li><a class="reference internal" href="#class">1 Class</a></li>
<li><a class="reference internal" href="#functions">3 Functions</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="IPython.lib.security.html"
                        title="previous chapter">Module: <tt class="docutils literal"><span class="pre">lib.security</span></tt></a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="IPython.nbconvert.exporters.exporter.html"
                        title="next chapter">Module: <tt class="docutils literal"><span class="pre">nbconvert.exporters.exporter</span></tt></a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../../_sources/api/generated/IPython.nbconvert.exporters.export.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-IPython.nbconvert.exporters.export">
<span id="module-nbconvert-exporters-export"></span><h1>Module: <tt class="xref py py-mod docutils literal"><span class="pre">nbconvert.exporters.export</span></tt><a class="headerlink" href="#module-IPython.nbconvert.exporters.export" title="Permalink to this headline">¶</a></h1>
<p>Module containing single call export functions.</p>
<div class="section" id="class">
<h2>1 Class<a class="headerlink" href="#class" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="IPython.nbconvert.exporters.export.ExporterNameError">
<em class="property">class </em><tt class="descclassname">IPython.nbconvert.exporters.export.</tt><tt class="descname">ExporterNameError</tt><a class="headerlink" href="#IPython.nbconvert.exporters.export.ExporterNameError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="http://docs.python.org/2/library/exceptions.html#exceptions.NameError" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">exceptions.NameError</span></tt></a></p>
</dd></dl>

</div>
<div class="section" id="functions">
<h2>3 Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="IPython.nbconvert.exporters.export.export">
<tt class="descclassname">IPython.nbconvert.exporters.export.</tt><tt class="descname">export</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.nbconvert.exporters.export.export" title="Permalink to this definition">¶</a></dt>
<dd><p>Export a notebook object using specific exporter class.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>exporter</strong> : class:<cite>~IPython.nbconvert.exporters.exporter.Exporter</cite> class or instance</p>
<blockquote>
<div><p>Class type or instance of the exporter that should be used.  If the
method initializes it&#8217;s own instance of the class, it is ASSUMED that
the class type provided exposes a constructor (<tt class="docutils literal"><span class="pre">__init__</span></tt>) with the same
signature as the base Exporter class.</p>
</div></blockquote>
<p><strong>nb</strong> : <a class="reference internal" href="IPython.nbformat.v3.nbbase.html#IPython.nbformat.v3.nbbase.NotebookNode" title="IPython.nbformat.v3.nbbase.NotebookNode"><tt class="xref py py-class docutils literal"><span class="pre">NotebookNode</span></tt></a></p>
<blockquote>
<div><p>The notebook to export.</p>
</div></blockquote>
<p><strong>config</strong> : config (optional, keyword arg)</p>
<blockquote>
<div><p>User configuration instance.</p>
</div></blockquote>
<p><strong>resources</strong> : dict (optional, keyword arg)</p>
<blockquote>
<div><p>Resources used in the conversion process.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">tuple- output, resources, exporter_instance</p>
<p><strong>output</strong> : str</p>
<blockquote>
<div><p>Jinja 2 output.  This is the resulting converted notebook.</p>
</div></blockquote>
<p><strong>resources</strong> : dictionary</p>
<blockquote>
<div><p>Dictionary of resources used prior to and during the conversion 
process.</p>
</div></blockquote>
<p><strong>exporter_instance</strong> : Exporter</p>
<blockquote class="last">
<div><p>Instance of the Exporter class used to export the document.  Useful
to caller because it provides a &#8216;file_extension&#8217; property which
specifies what extension the output should be saved as.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>WARNING: API WILL CHANGE IN FUTURE RELEASES OF NBCONVERT</p>
</dd></dl>

<dl class="function">
<dt id="IPython.nbconvert.exporters.export.export_by_name">
<tt class="descclassname">IPython.nbconvert.exporters.export.</tt><tt class="descname">export_by_name</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#IPython.nbconvert.exporters.export.export_by_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Export a notebook object to a template type by its name.  Reflection
(Inspect) is used to find the template&#8217;s corresponding explicit export
method defined in this module.  That method is then called directly.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>format_name</strong> : str</p>
<blockquote>
<div><p>Name of the template style to export to.</p>
</div></blockquote>
<p><strong>nb</strong> : <a class="reference internal" href="IPython.nbformat.v3.nbbase.html#IPython.nbformat.v3.nbbase.NotebookNode" title="IPython.nbformat.v3.nbbase.NotebookNode"><tt class="xref py py-class docutils literal"><span class="pre">NotebookNode</span></tt></a></p>
<blockquote>
<div><p>The notebook to export.</p>
</div></blockquote>
<p><strong>config</strong> : config (optional, keyword arg)</p>
<blockquote>
<div><p>User configuration instance.</p>
</div></blockquote>
<p><strong>resources</strong> : dict (optional, keyword arg)</p>
<blockquote>
<div><p>Resources used in the conversion process.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">tuple- output, resources, exporter_instance</p>
<p><strong>output</strong> : str</p>
<blockquote>
<div><p>Jinja 2 output.  This is the resulting converted notebook.</p>
</div></blockquote>
<p><strong>resources</strong> : dictionary</p>
<blockquote>
<div><p>Dictionary of resources used prior to and during the conversion 
process.</p>
</div></blockquote>
<p><strong>exporter_instance</strong> : Exporter</p>
<blockquote class="last">
<div><p>Instance of the Exporter class used to export the document.  Useful
to caller because it provides a &#8216;file_extension&#8217; property which
specifies what extension the output should be saved as.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>WARNING: API WILL CHANGE IN FUTURE RELEASES OF NBCONVERT</p>
</dd></dl>

<dl class="function">
<dt id="IPython.nbconvert.exporters.export.get_export_names">
<tt class="descclassname">IPython.nbconvert.exporters.export.</tt><tt class="descname">get_export_names</tt><big>(</big><big>)</big><a class="headerlink" href="#IPython.nbconvert.exporters.export.get_export_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of the currently supported export targets</p>
<p>WARNING: API WILL CHANGE IN FUTURE RELEASES OF NBCONVERT</p>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="IPython.nbconvert.exporters.exporter.html" title="Module: nbconvert.exporters.exporter"
             >next</a> |</li>
        <li class="right" >
          <a href="IPython.lib.security.html" title="Module: lib.security"
             >previous</a> |</li>
        <li><a href="http://ipython.org">home</a>|&nbsp;</li>
        <li><a href="../../search.html">search</a>|&nbsp;</li>
       <li><a href="../../index.html">documentation </a> &raquo;</li>

          <li><a href="../index.html" >The IPython API</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright The IPython Development Team.
      Last updated on Jul 14, 2015.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
    </div>
  </body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional