mirror of
https://github.com/wxWidgets/Phoenix.git
synced 2026-01-04 19:10:09 +01:00
4fee2a598a
- Reformat the documentation generator to take into account the "adv" sub-package; - Make the `sphinx_generator.py` and the `sphinxtools` package Python 3 - compliant. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71589 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
106 lines
4.4 KiB
HTML
106 lines
4.4 KiB
HTML
{% extends "layout.html" %}
|
|
{% set title = 'Documentation' %}
|
|
{% block body %}
|
|
<h1>Welcome to wxPython (Phoenix)'s documentation!</h1>
|
|
|
|
<div class="quotebar">
|
|
<p><em>SVN Revisions</em></p>
|
|
<p>“Built with wxWidgets & wxPython SVN revision <b>|SVN|</b>”</p>
|
|
</div>
|
|
|
|
<p>
|
|
Welcome! This is the documentation for wxPython {{ release }}, last updated |TODAY|.
|
|
</p>
|
|
|
|
<p>
|
|
This is the first, very-alpha release of this set of documentation. Documentation TODOs:
|
|
|
|
<ul>
|
|
<li><del>Add the pure-Python classes, methods and functions (i.e., <i>wx.CallAfter</i>)</del> </li>
|
|
<li>Find a way to link snippets of code to (almost) every class (maybe from the demo?)</li>
|
|
<li>Link the documentation to the wxPython Wiki (a web crawler will be needed)</li>
|
|
<li>Add <i>wx.lib</i> and the various other pure-Python third party libraries</li>
|
|
</ul>
|
|
</p>
|
|
<p>
|
|
<br>
|
|
<b>Phoenix</b> is the code name of for the new version of wxPython. <i>Robin Dunn</i> called this the Phoenix project
|
|
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.
|
|
</p>
|
|
|
|
<p>
|
|
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>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
|
|
</li>
|
|
<li><b>TODO List:</b> maily for developers, <a href="TODO.html">this document</a> explains what
|
|
remains to be done in order to complete the Phoenix project</li>
|
|
<li><b>Project Goals:</b> this external <a href="http://wiki.wxpython.org/ProjectPhoenix/ProjectGoals">link</a>
|
|
highlights the project goals and the driving forces behind it</li>
|
|
<li><b>Development Process:</b> this external <a href="http://wiki.wxpython.org/ProjectPhoenix/DevelopmentProcess">link</a>
|
|
shows the main thoughts behind the project Phoenix implementation</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>
|
|
|
|
<p>
|
|
The Phoenix documentation has been built automatically starting from XML files representing the
|
|
<a href="http://www.wxwidgets.org/">wxWidgets</a> C++ documentation (generated using <a href="www.doxygen.org/">Doxygen</a>).
|
|
</p>
|
|
|
|
<p>
|
|
I developed a set of <a href="www.python.org/">Python</a> routines to translate this XML hell into
|
|
<a href="http://docutils.sf.net/rst.html">reStructuredText</a>. Then, <a href="www.sphinx.pocoo.org/">Sphinx</a>
|
|
has been used to generate the final set of documentation for Phoenix.
|
|
</p>
|
|
<br>
|
|
|
|
<h2>Documentation</h2>
|
|
|
|
<table class="contentstable" align="center" style="margin-left: 30px">
|
|
<tr>
|
|
<td width="50%">
|
|
<p class="biglink"><a class="biglink" href="{{ pathto("1classindex") }}">Phoenix Widgets</a><br/>
|
|
<span class="linkdescr">Swig-ed from wxWidgets</span></p>
|
|
|
|
<br/>
|
|
<p class="biglink"><a class="biglink" href="{{ pathto("functions") }}">Phoenix Functions</a><br/>
|
|
<span class="linkdescr">Standalone/Static functions</span></p>
|
|
</td>
|
|
<td width="50%">
|
|
<p class="biglink"><a class="biglink" >Wrapped Sub-Modules</a><br/>
|
|
<span class="linkdescr">Contained in <i>wx.something</i> modules</span></p>
|
|
<p>
|
|
</p>
|
|
<ul>
|
|
<li><a href="adv.1classindex.html">adv</a></li>
|
|
<li><a href="dataview.1classindex.html">dataview</a></li>
|
|
</ul>
|
|
<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, formerly the PyCrust package.</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 (Editra, XRCed).</span></p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
|
|
{% endblock %} |