Phoenix/docs/sphinx/_templates/main.html

{% extends "layout.html" %}
{% set title = 'Documentation' %}
{% block body %}
  <h1>wxPython-Phoenix Reference Documentation</h1>

  <p>
    Welcome! This is the documentation for wxPython {{ release }}, last updated |TODAY| from
    revision |VCSREV|.
  </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: 25px">
    <tr>
    <td width="50%" valign="top">
      <p class="biglink"><a class="biglink" href="{{ pathto("1classindex") }}">Core wx Classes</a><br/>
         <span class="linkdescr">The classes which appear in the main wx namespace</span></p>

      <p class="biglink"><a class="biglink" href="{{ pathto("functions") }}">Core Functions</a><br/>
         <span class="linkdescr">Standalone functions in the main wx namespace</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("dataview.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>

      <p class="biglink"><a class="biglink" href="{{ pathto("html.1classindex") }}">wx.html</a><br/>
         <span class="linkdescr">Widget and supporting classes for a generic html renderer</span></p>

      <p class="biglink"><a class="biglink" href="{{ pathto("html2.1classindex") }}">wx.html2</a><br/>
         <span class="linkdescr">Widget and supporting classes for a native html renderer, with CSS and javascript support</span></p>

      <p class="biglink"><a class="biglink" href="{{ pathto("grid.1classindex") }}">wx.grid</a><br/>
         <span class="linkdescr">Widget and supporting classes for displaying and editing tabular data</span></p>

    </td>
    <td valign="top" width="50%" style="margin-left: 5px">
      <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("glcanvas.1classindex") }}">wx.glcanvas</a><br/>
         <span class="linkdescr">Classes for embedding OpenGL views in a window</span></p>

      <p class="biglink"><a class="biglink" href="{{ pathto("richtext.1classindex") }}">wx.richtext</a><br/>
         <span class="linkdescr">A generic, ground-up implementation of a text control capable of showing multiple text styles and images.</span></p>

      <p class="biglink"><a class="biglink" href="{{ pathto("xrc.1classindex") }}">wx.xrc</a><br/>
         <span class="linkdescr">Classes for loading widgets and layout from XML</span></p>

      <p class="biglink"><a class="biglink" href="{{ pathto("media.1classindex") }}">wx.media</a><br/>
         <span class="linkdescr">MediaCtrl and related classes</span></p>

      <p class="biglink"><a class="biglink" href="{{ pathto("xml.1classindex") }}">wx.xml</a><br/>
         <span class="linkdescr">Some simple XML classes for use with XRC</span></p>

      <p class="biglink"><a class="biglink" href="msw.1classindex.html">wx.msw</a><br/>
         <span class="linkdescr">A few classes available only Windows</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 %}