Diff of /doc/html/about_pyke/installing_pyke.html [e6e990] .. [c237fe] Maximize Restore

  Switch to unified view

a/doc/html/about_pyke/installing_pyke.html b/doc/html/about_pyke/installing_pyke.html
...
...
82
<li><a class="reference internal" href="#installing-the-sources">Installing the Sources</a></li>
82
<li><a class="reference internal" href="#installing-the-sources">Installing the Sources</a></li>
83
<li><a class="reference internal" href="#installing-the-examples">Installing the Examples</a></li>
83
<li><a class="reference internal" href="#installing-the-examples">Installing the Examples</a></li>
84
<li><a class="reference internal" href="#installing-the-html-documentation">Installing the HTML Documentation</a></li>
84
<li><a class="reference internal" href="#installing-the-html-documentation">Installing the HTML Documentation</a></li>
85
</ul>
85
</ul>
86
</li>
86
</li>
87
<li><a class="reference internal" href="#mercurial-repositories">Mercurial Repositories</a><ul>
87
<li><a class="reference internal" href="#subversion-directories">Subversion Directories</a></li>
88
<li><a class="reference internal" href="#repository-directory-structure">Repository Directory Structure</a></li>
89
</ul>
90
</li>
88
<li><a class="reference internal" href="#documentation">Documentation</a></li>
91
<li><a class="reference internal" href="#documentation">Documentation</a></li>
89
</ul>
92
</ul>
90
</div>
93
</div>
91
<div class="section" id="licensing">
94
<div class="section" id="licensing">
92
<h2>Licensing</h2>
95
<h2>Licensing</h2>
...
...
128
</div>
131
</div>
129
<div class="section" id="installing-the-sources">
132
<div class="section" id="installing-the-sources">
130
<h3>Installing the Sources</h3>
133
<h3>Installing the Sources</h3>
131
<p>The source code for the latest release can be found on the <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=207724">Pyke project
134
<p>The source code for the latest release can be found on the <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=207724">Pyke project
132
download page</a> as <tt class="docutils literal"><span class="pre">pyke-&lt;release&gt;.tar.gz</span></tt>.</p>
135
download page</a> as <tt class="docutils literal"><span class="pre">pyke-&lt;release&gt;.tar.gz</span></tt>.</p>
133
<p>If you want the latest developer version, read <a class="reference internal" href="#subversion-directories">Subversion Directories</a>,
136
<p>If you want the latest developer version, read <a class="reference internal" href="#mercurial-repositories">Mercurial Repositories</a>,
134
below.</p>
137
below.</p>
135
</div>
138
</div>
136
<div class="section" id="installing-the-examples">
139
<div class="section" id="installing-the-examples">
137
<h3>Installing the Examples</h3>
140
<h3>Installing the Examples</h3>
138
<p>There are several examples that are contained in the source directory.
141
<p>There are several examples that are contained in the source directory.
...
...
148
it is in the source directory (doc/html), or you can download just the
151
it is in the source directory (doc/html), or you can download just the
149
documentation itself as <tt class="docutils literal"><span class="pre">pyke_doc_html-&lt;release&gt;.zip</span></tt> file from the
152
documentation itself as <tt class="docutils literal"><span class="pre">pyke_doc_html-&lt;release&gt;.zip</span></tt> file from the
150
<a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=207724">Pyke project download page</a>.</p>
153
<a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=207724">Pyke project download page</a>.</p>
151
</div>
154
</div>
152
</div>
155
</div>
153
<div class="section" id="subversion-directories">
156
<div class="section" id="mercurial-repositories">
154
<h2>Subversion Directories</h2>
157
<h2>Mercurial Repositories</h2>
158
<p>With <a class="reference external" href="http://mercurial.selenic.com/wiki/">mercurial</a>, you clone the entire repository locally on your computer.
159
Then you can make changes and commit those changes to your local repository.
160
If you think those changes might be interesting to everybody, make your local
161
repository (or a clone of it) publically available (either on your own server,
162
or on one of the <a class="reference external" href="http://mercurial.selenic.com/wiki/MercurialHosting">mercurial hosting sites</a>) and send me an email.  I will
163
examine your changes and pull them into the master repository on sourceforge.</p>
155
<p>To check out the development version of the entire project (including the
164
<p>To clone the development version of the entire project (including the
156
<a class="reference external" href="../examples.html">examples</a> and this documentation) into a directory called <em>foobar</em>:</p>
165
<a class="reference external" href="../examples.html">examples</a> and this documentation) into a directory called <em>foobar</em>:</p>
157
<pre class="literal-block">
166
<pre class="literal-block">
158
$ svn checkout https://pyke.svn.sourceforge.net/svnroot/pyke/trunk foobar
167
$ hg clone http://pyke.hg.sourceforge.net:8000/hgroot/pyke/pyke foobar
159
</pre>
168
</pre>
160
<p>Or to checkout the latest release 1.0 branch:</p>
169
<p>Or to clone the latest release 1 branch:</p>
161
<pre class="literal-block">
170
<pre class="literal-block">
162
$ svn checkout https://pyke.svn.sourceforge.net/svnroot/pyke/branches/release_1.0 foobar
171
$ hg clone http://pyke.hg.sourceforge.net:8000/hgroot/pyke/release_1 foobar
163
</pre>
172
</pre>
164
<p>Anybody can check out the code, but only project members may do
173
<p>Use the <em>release_1</em> repository for any work that improves the quality of the
165
<tt class="docutils literal"><span class="pre">commits</span></tt>.  Send me an email if you'd like to lend a hand!</p>
174
code (bug fixes, code formatting, comments, documentation) that won't break
166
<p>You'll see the following directories.  You can also use <tt class="docutils literal"><span class="pre">svn</span></tt> to check these
175
existing programs and can go into the next point release.</p>
167
out individually by simply adding the directory name onto the end of the url in
176
<p>Use the <em>pyke</em> repository for new features that will go into the next major
168
the example above and changing the directory that you want it to go into.</p>
177
release.  I merge all the changes done in the release_1 repository into the
178
pyke repository.</p>
179
<p>Finally, use the <em>pre_2to3</em> repository for any work that is specific to the
180
Python3 version of PyKE.  Just don't run 2to3 in directly in your working
181
directory because it will change all of the .py files and we don't want those
182
changes committed!  I merge all the changes done in the pyke repository
183
into the pre_2to3 repository.</p>
184
<div class="section" id="repository-directory-structure">
185
<h3>Repository Directory Structure</h3>
186
<p>You'll see the following directories.</p>
169
<ul class="simple">
187
<ul class="simple">
170
<li><tt class="docutils literal"><span class="pre">doc</span></tt><ul>
188
<li><tt class="docutils literal"><span class="pre">doc</span></tt><ul>
171
<li>See <a class="reference internal" href="#documentation">Documentation</a>, below.</li>
189
<li>See <a class="reference internal" href="#documentation">Documentation</a>, below.</li>
172
</ul>
190
</ul>
173
</li>
191
</li>
...
...
184
which is expected to be a subpackage of <tt class="docutils literal"><span class="pre">pyke</span></tt>.</li>
202
which is expected to be a subpackage of <tt class="docutils literal"><span class="pre">pyke</span></tt>.</li>
185
</ul>
203
</ul>
186
</li>
204
</li>
187
</ul>
205
</ul>
188
</div>
206
</div>
207
</div>
189
<div class="section" id="documentation">
208
<div class="section" id="documentation">
190
<h2>Documentation</h2>
209
<h2>Documentation</h2>
191
<p>The <tt class="docutils literal"><span class="pre">doc/html</span></tt> directory in subversion contains all of these documents.
210
<p>The <tt class="docutils literal"><span class="pre">doc/html</span></tt> directory in <a class="reference external" href="http://mercurial.selenic.com/wiki/">mercurial</a> contains all of these documents.
192
You can browse these on your hard drive if you'd like.</p>
211
You can browse these on your hard drive if you'd like.</p>
193
<p>If you want to regenerate these documents, you'll also need:</p>
212
<p>If you want to regenerate these documents, you'll also need:</p>
194
<ul class="simple">
213
<ul class="simple">
195
<li><a class="reference external" href="http://sourceforge.net/projects/rest2web">Rest2web</a>, which requires:</li>
214
<li><a class="reference external" href="http://sourceforge.net/projects/rest2web">Rest2web</a>, which requires:</li>
196
<li><a class="reference external" href="http://sourceforge.net/projects/docutils">Docutils</a></li>
215
<li><a class="reference external" href="http://sourceforge.net/projects/docutils">Docutils</a></li>
...
...
207
<li>except for those in <tt class="docutils literal"><span class="pre">doc/html/stylesheets</span></tt> and <tt class="docutils literal"><span class="pre">doc/html/images</span></tt>.</li>
226
<li>except for those in <tt class="docutils literal"><span class="pre">doc/html/stylesheets</span></tt> and <tt class="docutils literal"><span class="pre">doc/html/images</span></tt>.</li>
208
</ul>
227
</ul>
209
</li>
228
</li>
210
<li>Then strips all of the hyperlink references from the *.txt files.</li>
229
<li>Then strips all of the hyperlink references from the *.txt files.</li>
211
</ol>
230
</ol>
212
<p>I've gone ahead and placed the generated html files in subversion so that
231
<p>I've gone ahead and placed the generated html files in mercurial so that
213
you can checkout the documentation without having to run <tt class="docutils literal"><span class="pre">bin/gen_html</span></tt>.</p>
232
you can browse the documentation without having to run <tt class="docutils literal"><span class="pre">bin/gen_html</span></tt>.</p>
214
<!-- ADD_LINKS MARKER -->
233
<!-- ADD_LINKS MARKER -->
215
</div>
234
</div>
216
</div>
235
</div>
217
236
218
                <!-- <div id="return-to-top">
237
                <!-- <div id="return-to-top">
...
...
248
    </tfoot>
267
    </tfoot>
249
  </table>
268
  </table>
250
269
251
  <div id="last-modified">
270
  <div id="last-modified">
252
    Page last modified
271
    Page last modified
253
    Fri, Mar 06 2009.
272
    Mon, Oct 19 2009.
254
273
255
  </div>
274
  </div>
256
275
257
  <script type="text/javascript">
276
  <script type="text/javascript">
258
    var gaJsHost = (("https:" == document.location.protocol) ?
277
    var gaJsHost = (("https:" == document.location.protocol) ?