Mercurial > pymonkey

comparison docs/rendered/index.html @ 51:fabd3f2271fa

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added some basic, incomplete docs on the pymonkey module, which include a doctest that's run when pymonkey is built.
author Atul Varma <varmaa@toolness.com>
date Wed, 08 Jul 2009 09:32:31 -0700
parents 7401af070bb8
children e9f450d30c0e
comparison
equal deleted inserted replaced
50:405f03166009 51:fabd3f2271fa
17 HAS_SOURCE: true 17 HAS_SOURCE: true
18 }; 18 };
19 </script> 19 </script>
20 <script type="text/javascript" src="_static/jquery.js"></script> 20 <script type="text/javascript" src="_static/jquery.js"></script>
21 <script type="text/javascript" src="_static/doctools.js"></script> 21 <script type="text/javascript" src="_static/doctools.js"></script>
22 <link rel="top" title="Pymonkey v0.0.1 documentation" href="" /> 22 <link rel="top" title="Pymonkey v0.0.1 documentation" href="" />
23 <link rel="next" title="pymonkey — Access SpiderMonkey from Python" href="pymonkey.html" />
23 </head> 24 </head>
24 <body> 25 <body>
25 <div class="related"> 26 <div class="related">
26 <h3>Navigation</h3> 27 <h3>Navigation</h3>
27 <ul> 28 <ul>
28 <li class="right" style="margin-right: 10px"> 29 <li class="right" style="margin-right: 10px">
29 <a href="genindex.html" title="General Index" 30 <a href="genindex.html" title="General Index"
30 accesskey="I">index</a></li> 31 accesskey="I">index</a></li>
32 <li class="right" >
33 <a href="modindex.html" title="Global Module Index"
34 accesskey="M">modules</a> |</li>
35 <li class="right" >
36 <a href="pymonkey.html" title="pymonkey — Access SpiderMonkey from Python"
37 accesskey="N">next</a> |</li>
31 <li><a href="">Pymonkey v0.0.1 documentation</a> &raquo;</li> 38 <li><a href="">Pymonkey v0.0.1 documentation</a> &raquo;</li>
32 </ul> 39 </ul>
33 </div> 40 </div>
34 41
35 <div class="document"> 42 <div class="document">
40 <div class="section" id="pymonkey-documentation"> 47 <div class="section" id="pymonkey-documentation">
41 <h1>Pymonkey Documentation<a class="headerlink" href="#pymonkey-documentation" title="Permalink to this headline">¶</a></h1> 48 <h1>Pymonkey Documentation<a class="headerlink" href="#pymonkey-documentation" title="Permalink to this headline">¶</a></h1>
42 <p>Pymonkey is a Python C extension module to expose the <a class="reference" href="https://developer.mozilla.org/en/SpiderMonkey">Mozilla 49 <p>Pymonkey is a Python C extension module to expose the <a class="reference" href="https://developer.mozilla.org/en/SpiderMonkey">Mozilla
43 SpiderMonkey</a> engine 50 SpiderMonkey</a> engine
44 to Python.</p> 51 to Python.</p>
45 <ul class="simple"> 52 <ul>
53 <li class="toctree-l1"><a class="reference" href="pymonkey.html"><tt class="docutils literal"><span class="pre">pymonkey</span></tt> &#8212; Access SpiderMonkey from Python</a></li>
46 </ul> 54 </ul>
47 <p>Rationale and Goals:</p> 55 <p>Rationale and Goals:</p>
48 <ul> 56 <ul>
49 <li><p class="first">Python and JS are fairly complementary languages. Python provides 57 <li><p class="first">Python and JS are fairly complementary languages. Python provides
50 tremendous developer productivity via its dynamic language 58 tremendous developer productivity via its dynamic language
107 </div> 115 </div>
108 <p>Where <tt class="docutils literal"><span class="pre">PATH_TO_OBJDIR</span></tt> is the path to your Mozilla/SpiderMonkey build&#8217;s 116 <p>Where <tt class="docutils literal"><span class="pre">PATH_TO_OBJDIR</span></tt> is the path to your Mozilla/SpiderMonkey build&#8217;s
109 objdir.</p> 117 objdir.</p>
110 <p>Note that at the moment, the build script is only tested on OS X.</p> 118 <p>Note that at the moment, the build script is only tested on OS X.</p>
111 </div> 119 </div>
112 <div class="section" id="example-code">
113 <h2>Example Code<a class="headerlink" href="#example-code" title="Permalink to this headline">¶</a></h2>
114 <p>Right now the only example code that exists is in the test suite at
115 <tt class="docutils literal"><span class="pre">test_pymonkey.py</span></tt>. Check it out and feel free to add more.</p>
116 </div>
117 <div class="section" id="challenges"> 120 <div class="section" id="challenges">
118 <h2>Challenges<a class="headerlink" href="#challenges" title="Permalink to this headline">¶</a></h2> 121 <h2>Challenges<a class="headerlink" href="#challenges" title="Permalink to this headline">¶</a></h2>
119 <p>There&#8217;s a number of challenges that need to be resolved before 122 <p>There&#8217;s a number of challenges that need to be resolved before
120 pymonkey can be really usable. Here&#8217;s some of them.</p> 123 pymonkey can be really usable. Here&#8217;s some of them.</p>
121 <p><strong>Garbage Collection</strong></p> 124 <p><strong>Garbage Collection</strong></p>
145 <div class="sphinxsidebarwrapper"> 148 <div class="sphinxsidebarwrapper">
146 <h3><a href="">Table Of Contents</a></h3> 149 <h3><a href="">Table Of Contents</a></h3>
147 <ul> 150 <ul>
148 <li><a class="reference" href="">Pymonkey Documentation</a><ul> 151 <li><a class="reference" href="">Pymonkey Documentation</a><ul>
149 <li><a class="reference" href="#building-and-testing">Building and Testing</a></li> 152 <li><a class="reference" href="#building-and-testing">Building and Testing</a></li>
150 <li><a class="reference" href="#example-code">Example Code</a></li>
151 <li><a class="reference" href="#challenges">Challenges</a></li> 153 <li><a class="reference" href="#challenges">Challenges</a></li>
152 <li><a class="reference" href="#indices-and-tables">Indices and Tables</a></li> 154 <li><a class="reference" href="#indices-and-tables">Indices and Tables</a></li>
153 </ul> 155 </ul>
154 </li> 156 </li>
155 </ul> 157 </ul>
156 158
159 <h4>Next topic</h4>
160 <p class="topless"><a href="pymonkey.html"
161 title="next chapter"><tt class="docutils literal"><span class="pre">pymonkey</span></tt> &#8212; Access SpiderMonkey from Python</a></p>
157 <h3>This Page</h3> 162 <h3>This Page</h3>
158 <ul class="this-page-menu"> 163 <ul class="this-page-menu">
159 <li><a href="_sources/index.txt" 164 <li><a href="_sources/index.txt"
160 rel="nofollow">Show Source</a></li> 165 rel="nofollow">Show Source</a></li>
161 </ul> 166 </ul>
180 <h3>Navigation</h3> 185 <h3>Navigation</h3>
181 <ul> 186 <ul>
182 <li class="right" style="margin-right: 10px"> 187 <li class="right" style="margin-right: 10px">
183 <a href="genindex.html" title="General Index" 188 <a href="genindex.html" title="General Index"
184 >index</a></li> 189 >index</a></li>
190 <li class="right" >
191 <a href="modindex.html" title="Global Module Index"
192 >modules</a> |</li>
193 <li class="right" >
194 <a href="pymonkey.html" title="pymonkey — Access SpiderMonkey from Python"
195 >next</a> |</li>
185 <li><a href="">Pymonkey v0.0.1 documentation</a> &raquo;</li> 196 <li><a href="">Pymonkey v0.0.1 documentation</a> &raquo;</li>
186 </ul> 197 </ul>
187 </div> 198 </div>
188 <div class="footer"> 199 <div class="footer">
189 &copy; Copyright 2009, Atul Varma. 200 &copy; Copyright 2009, Atul Varma.