Rename some doc files --> *.rst for editor support and for GitHub visibility.

This commit is contained in:
Robin Dunn
2016-05-11 20:02:03 -07:00
parent c42ee6bce3
commit 028d173676
6 changed files with 37 additions and 48 deletions

19
.gitignore vendored
View File

@@ -6,29 +6,26 @@
.waf-*
.waf3-*
.lock-waf*
wingdbstub.py*
mydbstub.py*
.idea
# /
/.hg
/.hgignore
/build
/build_waf
/tmp
/dist
/license
/*.egg-info
/REV.txt
# /bin/
/bin/sip-*
/bin/waf-*
/bin/waf3-*
/bin/doxygen-*
# /docs/sphinx/
/docs/html
/docs/sphinx/*.txt
/docs/sphinx/*.rst
/docs/sphinx/*.pkl
/docs/sphinx/*.inc
/docs/sphinx/*.lst
@@ -38,20 +35,14 @@
/docs/sphinx/build
# /sip/cpp/
/sip/cpp/sip.signature
/sip/cpp/*.sbf
/sip/cpp/*.h
/sip/cpp/*.cpp
/sip/cpp-*
# /sip/gen/
/sip/gen/*.sip
# /sip/siplib/
/sip/siplib/.update
# /wx/
/wx/*.py
/wx/*.pyc
/wx/*.pi
@@ -61,6 +52,6 @@
/wx/*.dylib
/wx/libwx_*
/wx/locale
/unittests/lib_pubsub_provider_actual.py
wingdbstub.py*
/unittests/lib_pubsub_provider_actual.py

View File

@@ -169,36 +169,36 @@ Other Dev Stuff
a[0]
a[0][0]
* In a Py3 build strings like wx.TreeCtrlNameStr are being generated as
bytes objects, they should probably be string objects. Or not, sip's
default might be best... See ModuleDef.addGlobalStr if I change my mind.
* In a Py3 build strings like wx.TreeCtrlNameStr are being generated as
bytes objects, they should probably be string objects. Or not, sip's
default might be best... See ModuleDef.addGlobalStr if I change my mind.
* If a function or method has overloads but all but one all ignored then the doc
generator should not use the "*args, **kw" form of output and just use the
args string of the remaining function or method definition like for those
that do not have overloads. For example, see Window.GetClientSize
* If a function or method has overloads but all but one all ignored then the doc
generator should not use the "*args, **kw" form of output and just use the
args string of the remaining function or method definition like for those
that do not have overloads. For example, see Window.GetClientSize
* Check gui_scripts entry points.
* Check gui_scripts entry points.
* wx.Window.DoEraseBackground?
* wx.Window.DoEraseBackground?
* The sphinxtools are too aggressive at ignoring content beyond a #. If the hash
happens to be inside a string then syntax related errors can happen. For example:
* The sphinxtools are too aggressive at ignoring content beyond a #. If the hash
happens to be inside a string then syntax related errors can happen. For example:
def SetColors(self, pen='black', fill='#A0A0A0', fill2='#E0E0E0'):
...
def SetColors(self, pen='black', fill='#A0A0A0', fill2='#E0E0E0'):
...
* Add tests and/or demo for DnD in DataViewCtrl. Since the DnD is done
internally and the DataViewEvent is used for passing the data objects
around we may need to do something to help convert the raw data to python
DataObjects.
* Add tests and/or demo for DnD in DataViewCtrl. Since the DnD is done
internally and the DataViewEvent is used for passing the data objects
around we may need to do something to help convert the raw data to python
DataObjects.
* Add meaningful __hash__ methods for wx.Colour, wx.Point, etc.?
* Add meaningful __hash__ methods for wx.Colour, wx.Point, etc.?
* Double-check wx.PyEvent and wx.PyCommandEvent, does the
__getattr__ etc. work with properties? See:
https://groups.google.com/d/msg/wxpython-dev/dMrpaKs_d0U/nVMY7lMvAwAJ
* Double-check wx.PyEvent and wx.PyCommandEvent, does the __getattr__,
etc. work with properties? See:
https://groups.google.com/d/msg/wxpython-dev/dMrpaKs_d0U/nVMY7lMvAwAJ

13
b
View File

@@ -2,16 +2,13 @@
##set -o xtrace
#PYVER=2.7
#PYVER2=27
PYVER=3.4
PYVER2=34
if [ "$OSTYPE" = "cygwin" ]; then
$TOOLS/python$PYVER2/python.exe -u build.py "$@"
PYTHON=`which python.exe`
echo $PYTHON
$PYTHON -u build.py "$@"
else
PATH=/usr/local/bin:$PATH
PYTHON=`which python$PYVER`
PYTHON=`which python`
echo $PYTHON
$PYTHON -u build.py "$@"
fi

View File

@@ -888,11 +888,12 @@ def cmd_sphinx(options, args):
SphinxIndexes(sphinxDir)
GenGallery()
todo = os.path.join(phoenixDir(), 'TODO.txt')
copyIfNewer(todo, sphinxDir)
txtFiles = glob.glob(os.path.join(phoenixDir(), 'docs', '*.txt'))
for txtFile in txtFiles:
copyIfNewer(txtFile, sphinxDir)
# Copy the hand-edited top level doc files too
rstFiles = [os.path.join(phoenixDir(), 'TODO.rst')] + \
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)
MakeHeadings()