PageRenderTime 55ms CodeModel.GetById 26ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/_build/html/api/file_system_helper.html

https://github.com/MarcinOS/librepy
HTML | 145 lines | 136 code | 9 blank | 0 comment | 0 complexity | f4e79e02b0fb1a3f64a4a1de69ebc90c MD5 | raw file
    

  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>file_system_helper &mdash; librepy v0.1 documentation</title>
    10. 

  10.     <link rel="stylesheet" href="../_static/nature.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    12. 

  12.     <script type="text/javascript">
    13. 

  13.       var DOCUMENTATION_OPTIONS = {
    14. 

  14.         URL_ROOT:    '../',
    15. 

  15.         VERSION:     '0.1',
    16. 

  16.         COLLAPSE_INDEX: false,
    17. 

  17.         FILE_SUFFIX: '.html',
    18. 

  18.         HAS_SOURCE:  true
    19. 

  19.       };
    20. 

  20.     </script>
    21. 

  21.     <script type="text/javascript" src="../_static/jquery.js"></script>
    22. 

  22.     <script type="text/javascript" src="../_static/underscore.js"></script>
    23. 

  23.     <script type="text/javascript" src="../_static/doctools.js"></script>
    24. 

  24.     <link rel="top" title="librepy v0.1 documentation" href="../index.html" />
    25. 

  25.     <link rel="up" title="API" href="index.html" />
    26. 

  26.     <link rel="next" title="models" href="models.html" />
    27. 

  27.     <link rel="prev" title="epub_gen" href="epub_gen.html" /> 
    28. 

  28.   </head>
    29. 

  29.   <body>
    30. 

  30.     <div class="related">
    31. 

  31.       <h3>Navigation</h3>
    32. 

  32.       <ul>
    33. 

  33.         <li class="right" style="margin-right: 10px">
    34. 

  34.           <a href="../genindex.html" title="General Index"
    35. 

  35.              accesskey="I">index</a></li>
    36. 

  36.         <li class="right" >
    37. 

  37.           <a href="../py-modindex.html" title="Python Module Index"
    38. 

  38.              >modules</a> |</li>
    39. 

  39.         <li class="right" >
    40. 

  40.           <a href="models.html" title="models"
    41. 

  41.              accesskey="N">next</a> |</li>
    42. 

  42.         <li class="right" >
    43. 

  43.           <a href="epub_gen.html" title="epub_gen"
    44. 

  44.              accesskey="P">previous</a> |</li>
    45. 

  45.         <li><a href="../index.html">librepy v0.1 documentation</a> &raquo;</li>
    46. 

  46.           <li><a href="index.html" accesskey="U">API</a> &raquo;</li> 
    47. 

  47.       </ul>
    48. 

  48.     </div>  
    49. 

  49. 

  50.     <div class="document">
    51. 

  51.       <div class="documentwrapper">
    52. 

  52.         <div class="bodywrapper">
    53. 

  53.           <div class="body">
    54. 

  54.             
    55. 

  55.   <div class="section" id="module-librepy.file_system_helper">
    56. 

  56. <span id="file-system-helper"></span><h1>file_system_helper<a class="headerlink" href="#module-librepy.file_system_helper" title="Permalink to this headline"></a></h1>
    57. 

  57. <p>File system helpers.</p>
    58. 

  58. <dl class="function">
    59. 

  59. <dt id="librepy.file_system_helper.create_dir_if_needed">
    60. 

  60. <tt class="descclassname">librepy.file_system_helper.</tt><tt class="descname">create_dir_if_needed</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../_modules/librepy/file_system_helper.html#create_dir_if_needed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#librepy.file_system_helper.create_dir_if_needed" title="Permalink to this definition"></a></dt>
    61. 

  61. <dd><p>Creates new directory at given location if there is no such directory</p>
    62. 

  62. </dd></dl>
    63. 

  63. 

  64. <dl class="function">
    65. 

  65. <dt id="librepy.file_system_helper.generate_file_from_template">
    66. 

  66. <tt class="descclassname">librepy.file_system_helper.</tt><tt class="descname">generate_file_from_template</tt><big>(</big><em>path</em>, <em>template_name</em>, <em>context</em>, <em>render_method='xml'</em><big>)</big><a class="reference internal" href="../_modules/librepy/file_system_helper.html#generate_file_from_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#librepy.file_system_helper.generate_file_from_template" title="Permalink to this definition"></a></dt>
    67. 

  67. <dd><p>Generate file at given path using template and given context</p>
    68. 

  68. <table class="docutils field-list" frame="void" rules="none">
    69. 

  69. <col class="field-name" />
    70. 

  70. <col class="field-body" />
    71. 

  71. <tbody valign="top">
    72. 

  72. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    73. 

  73. <li><strong>path</strong> &#8211; path where the file will be generated</li>
    74. 

  74. <li><strong>template_name</strong> &#8211; name of template which will be used to generate the file content.
    75. 

  75. It must be in templates dir configured in Genshi.</li>
    76. 

  76. <li><strong>context</strong> &#8211; dictionary containing values which will be injected into template slots</li>
    77. 

  77. <li><strong>render_method</strong> &#8211; document rendering method. See Genshi documentation.</li>
    78. 

  78. </ul>
    79. 

  79. </td>
    80. 

  80. </tr>
    81. 

  81. </tbody>
    82. 

  82. </table>
    83. 

  83. </dd></dl>
    84. 

  84. 

  85. </div>
    86. 

  86. 

  87. 

  88.           </div>
    89. 

  89.         </div>
    90. 

  90.       </div>
    91. 

  91.       <div class="sphinxsidebar">
    92. 

  92.         <div class="sphinxsidebarwrapper">
    93. 

  93.   <h4>Previous topic</h4>
    94. 

  94.   <p class="topless"><a href="epub_gen.html"
    95. 

  95.                         title="previous chapter">epub_gen</a></p>
    96. 

  96.   <h4>Next topic</h4>
    97. 

  97.   <p class="topless"><a href="models.html"
    98. 

  98.                         title="next chapter">models</a></p>
    99. 

  99.   <h3>This Page</h3>
    100. 

  100.   <ul class="this-page-menu">
    101. 

  101.     <li><a href="../_sources/api/file_system_helper.txt"
    102. 

  102.            rel="nofollow">Show Source</a></li>
    103. 

  103.   </ul>
    104. 

  104. <div id="searchbox" style="display: none">
    105. 

  105.   <h3>Quick search</h3>
    106. 

  106.     <form class="search" action="../search.html" method="get">
    107. 

  107.       <input type="text" name="q" size="18" />
    108. 

  108.       <input type="submit" value="Go" />
    109. 

  109.       <input type="hidden" name="check_keywords" value="yes" />
    110. 

  110.       <input type="hidden" name="area" value="default" />
    111. 

  111.     </form>
    112. 

  112.     <p class="searchtip" style="font-size: 90%">
    113. 

  113.     Enter search terms or a module, class or function name.
    114. 

  114.     </p>
    115. 

  115. </div>
    116. 

  116. <script type="text/javascript">$('#searchbox').show(0);</script>
    117. 

  117.         </div>
    118. 

  118.       </div>
    119. 

  119.       <div class="clearer"></div>
    120. 

  120.     </div>
    121. 

  121.     <div class="related">
    122. 

  122.       <h3>Navigation</h3>
    123. 

  123.       <ul>
    124. 

  124.         <li class="right" style="margin-right: 10px">
    125. 

  125.           <a href="../genindex.html" title="General Index"
    126. 

  126.              >index</a></li>
    127. 

  127.         <li class="right" >
    128. 

  128.           <a href="../py-modindex.html" title="Python Module Index"
    129. 

  129.              >modules</a> |</li>
    130. 

  130.         <li class="right" >
    131. 

  131.           <a href="models.html" title="models"
    132. 

  132.              >next</a> |</li>
    133. 

  133.         <li class="right" >
    134. 

  134.           <a href="epub_gen.html" title="epub_gen"
    135. 

  135.              >previous</a> |</li>
    136. 

  136.         <li><a href="../index.html">librepy v0.1 documentation</a> &raquo;</li>
    137. 

  137.           <li><a href="index.html" >API</a> &raquo;</li> 
    138. 

  138.       </ul>
    139. 

  139.     </div>
    140. 

  140.     <div class="footer">
    141. 

  141.         &copy; Copyright 2011, Marcin Świerczyński.
    142. 

  142.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    143. 

  143.     </div>
    144. 

  144.   </body>
    145. 

  145. </html>
    146.