Merge branch 'master' into release-prep

This commit is contained in:
Robin Dunn
2017-09-16 09:56:15 -07:00
4 changed files with 75 additions and 40 deletions

View File

@@ -952,8 +952,7 @@ def cmd_sphinx(options, args):
genGallery()
# Copy the hand-edited top level doc files too
rstFiles = [os.path.join(phoenixDir(), 'TODO.rst')] + \
glob.glob(os.path.join(phoenixDir(), 'docs', '*.rst'))
rstFiles = glob.glob(os.path.join(phoenixDir(), 'docs', '*.rst'))
for rst in rstFiles:
txt = os.path.join(sphinxDir, os.path.splitext(os.path.basename(rst))[0] + '.txt')
copyIfNewer(rst, txt)

View File

@@ -0,0 +1,54 @@
.. include:: headings.inc
.. _overviews:
=======================================
|phoenix_title| **Overview Documents**
=======================================
In addition to the API reference information for classes and functions in
wxPython, this documentation collection includes a number of overviews of
various aspects of the library, which are listed here.
.. toctree::
:maxdepth: 2
hello_world
app_overview
bitmap_overview
bookctrl_overview
command_overview
common_dialogs_overview
config_overview
dataobject_overview
datetime_overview
dc_overview
dialog_overview
dnd_overview
events_overview
filesystem_overview
font_encodings
font_overview
grid_overview
html_overview
internationalization
writing_non_english_applications
listctrl_overview
log_classes_overview
printing_framework_overview
refcount_overview
richtextctrl_overview
scrolling_overview
sizers_overview
splitterwindow_overview
standard_event_identifiers
stock_items
tipprovider_overview
toolbar_overview
treectrl_overview
validator_overview
window_deletion_overview
window_ids_overview
window_sizing_overview
window_styles_overview

View File

@@ -0,0 +1,15 @@
.. include:: headings.inc
.. _hello_world:
==========================================================
|phoenix_title| **wxPython Introduction and Hello World**
==========================================================
wxPython Introduction
---------------------
For a basic introduction to wxPython be sure to check out the
`wxPython Overview and Hello World <https://wxpython.org/pages/overview/>`_
page on the wxPython website.

View File

@@ -15,6 +15,10 @@ If you are porting your code from Classic wxPython, be sure to read the
`Migration Guide <MigrationGuide.html>`_ to get a better feel for
how some things have changed.
If you are new to wxPython then you may want to glance at the various
`overview documents <Overviews.html>`_ available here to get a feel for
how things work.
You can download a local copy of this documentation using a new utility script
included with wxPython called ``wxdocs``. It will open the local copy of the
documentation in your default browser, downloading it first if needed. There
@@ -106,47 +110,10 @@ and launch the wxPython demo for you.
:glob:
MigrationGuide
TODO
DocstringsGuidelines
Overviews
wx.functions
wx.1moduleindex
app_overview
bitmap_overview
bookctrl_overview
command_overview
common_dialogs_overview
config_overview
dataobject_overview
datetime_overview
dc_overview
dialog_overview
dnd_overview
events_overview
filesystem_overview
font_encodings
font_overview
grid_overview
html_overview
internationalization
writing_non_english_applications
listctrl_overview
log_classes_overview
printing_framework_overview
refcount_overview
richtextctrl_overview
scrolling_overview
sizers_overview
splitterwindow_overview
standard_event_identifiers
stock_items
tipprovider_overview
toolbar_overview
treectrl_overview
validator_overview
window_deletion_overview
window_ids_overview
window_sizing_overview
window_styles_overview
wx.adv.1moduleindex
wx.adv.functions
wx.dataview.1moduleindex