comparison docs/rendered/index.html @ 106:1e6523de9df1

Fixed docs to represent the much-simplified build process, fixed the test target to work w/ default build options, moved doctest output dir into build dir.
author Atul Varma <varmaa@toolness.com>
date Sun, 16 Aug 2009 12:53:46 -0700
parents e455f0f00e98
children 699d03db6614
comparison
equal deleted inserted replaced
105:9d4cd0803df5 106:1e6523de9df1
99 </li> 99 </li>
100 <li><p class="first">Finally, Atul has never really made a straight Python CAPI module 100 <li><p class="first">Finally, Atul has never really made a straight Python CAPI module
101 before, so he wanted to give it a try.</p> 101 before, so he wanted to give it a try.</p>
102 </li> 102 </li>
103 </ul> 103 </ul>
104 <div class="section" id="building-and-testing"> 104 <div class="section" id="building-testing-and-installing">
105 <h2>Building and Testing<a class="headerlink" href="#building-and-testing" title="Permalink to this headline">¶</a></h2> 105 <h2>Building, Testing, and Installing<a class="headerlink" href="#building-testing-and-installing" title="Permalink to this headline">¶</a></h2>
106 <p>You can either build SpiderMonkey off the mozilla-central HG 106 <p>From the root of your pymonkey repository, run:</p>
107 repository, or off a mirror I made of its SpiderMonkey directory. The 107 <div class="highlight-python"><pre>python setup.py build test</pre>
108 latter can be obtained here:</p> 108 </div>
109 <blockquote> 109 <p>This will build the C extension and run its test suite to ensure that
110 <a class="reference" href="http://hg.toolness.com/spidermonkey/">http://hg.toolness.com/spidermonkey/</a></blockquote> 110 everything works properly.</p>
111 <p>Just HG clone that repository in the root of your pymonkey repository
112 and read the instructions in the <tt class="docutils literal"><span class="pre">README</span></tt> file to build SpiderMonkey.</p>
113 <p>Then come back to the root of your pymonkey repository and run:</p>
114 <div class="highlight-python"><pre>python setup.py build</pre>
115 </div>
116 <p>Then run:</p> 111 <p>Then run:</p>
117 <div class="highlight-python"><pre>sudo python setup.py install</pre> 112 <div class="highlight-python"><pre>sudo python setup.py install</pre>
118 </div> 113 </div>
119 <p>Note that if you&#8217;re on Windows, you won&#8217;t need the <tt class="docutils literal"><span class="pre">sudo</span></tt> bit.</p> 114 <p>Note that if you&#8217;re on Windows, you won&#8217;t need the <tt class="docutils literal"><span class="pre">sudo</span></tt> bit.</p>
120 <p>You can run the test suite by entering:</p>
121 <div class="highlight-python"><pre>python setup.py test</pre>
122 </div>
123 </div> 115 </div>
124 <div class="section" id="challenges"> 116 <div class="section" id="challenges">
125 <h2>Challenges<a class="headerlink" href="#challenges" title="Permalink to this headline">¶</a></h2> 117 <h2>Challenges<a class="headerlink" href="#challenges" title="Permalink to this headline">¶</a></h2>
126 <p>There&#8217;s a number of challenges that need to be resolved before 118 <p>There&#8217;s a number of challenges that need to be resolved before
127 pymonkey can be really usable. Here&#8217;s some of them.</p> 119 pymonkey can be really usable. Here&#8217;s some of them.</p>
153 <div class="sphinxsidebar"> 145 <div class="sphinxsidebar">
154 <div class="sphinxsidebarwrapper"> 146 <div class="sphinxsidebarwrapper">
155 <h3><a href="">Table Of Contents</a></h3> 147 <h3><a href="">Table Of Contents</a></h3>
156 <ul> 148 <ul>
157 <li><a class="reference" href="">Pymonkey Documentation</a><ul> 149 <li><a class="reference" href="">Pymonkey Documentation</a><ul>
158 <li><a class="reference" href="#building-and-testing">Building and Testing</a></li> 150 <li><a class="reference" href="#building-testing-and-installing">Building, Testing, and Installing</a></li>
159 <li><a class="reference" href="#challenges">Challenges</a></li> 151 <li><a class="reference" href="#challenges">Challenges</a></li>
160 <li><a class="reference" href="#indices-and-tables">Indices and Tables</a></li> 152 <li><a class="reference" href="#indices-and-tables">Indices and Tables</a></li>
161 </ul> 153 </ul>
162 </li> 154 </li>
163 </ul> 155 </ul>