Add a TODO for docs

This commit is contained in:
Robin Dunn
2016-05-07 18:28:42 -07:00
parent f8d638b64e
commit 73a15ee2cc

View File

@@ -82,6 +82,25 @@ check if the the feature is available in wxWidgets or if the stubs should be
compiled.)
Reorganize Sphinx output
------------------------
To make it easier for 3rd party tools to find the docs for specific
classes and methods it would be good to change how the file names for
the class pages are generated. Currently it looks like just the
leading "wx." is missing from the file names. So that means that
classes in "core" do not have any package prefix in the filename at
all. For example, .../html/Bitmap.html instead of
.../html/wx.Bitmap.html. The same holds true for classes in the other
extension modules in wx, and also wx.lib.
.../html/adv.AnimationCtrl.html
.../html/lib.buttons.GenButton.html
etc.
The intra-document anchor links should also have the leading "wx."
added to them for consistency.
Other Dev Stuff