Files
Phoenix/docs/sphinx/_templates/main.html
2012-10-27 21:17:56 +00:00

83 lines
3.6 KiB
HTML

{% extends "layout.html" %}
{% set title = 'Documentation' %}
{% block body %}
<h1>Welcome to wxPython (Phoenix)'s documentation!</h1>
<p>
Welcome! This is the documentation for wxPython {{ release }}, last updated |TODAY| from
Subversion revision |SVN|.
</p>
<p>
<b>Phoenix</b> is the code name for the new version of wxPython. <i>Robin Dunn</i> called
this <a href="http://wiki.wxpython.org/ProjectPhoenix">Project Phoenix</a> because in the
process of doing this project wxPython's implementation will be utterly destroyed and then
reborn in a new and marvelous way, much like the mythical Phoenix rising from the ashes
of its former self. For wxPython many things about how the wrapper/bindings code is
produced will be changing, and we'll also be eliminating some other crud along the way.
</p>
<p>
Some interesting documents about the current status or the Phoenix project and its development:
</p>
<ul>
<li><b>Project Phoenix Wiki:</b> The <a href="http://wiki.wxpython.org/ProjectPhoenix">
Project Phoenix</a> section of the wxPython wiki has information about the background
of, and reasons for this project, as well as information for developers who want to help out.
</li>
<li><b>Migration Guide:</b> the <a href="MigrationGuide.html">Migration Guide</a> will give you
some hints on how to modify your existing wxPython applications to be compatible with Phoenix,
and the <a href="classic_vs_phoenix.html">Classic vs. Phoenix</a> document will give details
on the identifier names that have changed and what you should use instead in your applications.
These documents are updated as the project progresses, so be sure to check them often.
</li>
</ul>
<br>
<div class="admonition note">
<p class="first admonition-title">Note</p>
If you wish to help in the documentation effort, the main docstrings guidelines are outlined in
<a href="DocstringsGuidelines.html">this document</a>.
</div>
<br>
<h2>Documentation</h2>
<table class="contentstable" align="center" style="margin-left: 30px">
<tr>
<td width="50%" valign="top">
<p class="biglink"><a class="biglink" href="{{ pathto("1classindex") }}">Core Classes</a><br/>
<span class="linkdescr">The classes which appear in the wx namespace</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("functions") }}">Core Functions</a><br/>
<span class="linkdescr">Standalone/Static functions</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("adv.1classindex") }}">wx.adv</a><br/>
<span class="linkdescr">Less commonly used or more advanced classes</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("datavew.1classindex") }}">wx.dataview</a><br/>
<span class="linkdescr">Classes for viewing tabular or hierarchical data</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("stc.1classindex") }}">wx.stc</a><br/>
<span class="linkdescr">Classes for Styled Text Control, a.k.a Scintilla</span></p>
</td>
<td width="50%">
<p class="biglink"><a class="biglink" href="{{ pathto("lib") }}">wx.lib</a><br/>
<span class="linkdescr">Our pure-Python library of widgets</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("py") }}">wx.py</a><br/>
<span class="linkdescr">The py package, containing PyCrust and related modules</span></p>
<p class="biglink"><a class="biglink" href="{{ pathto("tools") }}">wx.tools</a><br/>
<span class="linkdescr">Some useful tools and utilities for wxPython.</span></p>
</td></tr>
</table>
{% endblock %}