Commit Graph

52 Commits

Author SHA1 Message Date
Robin Dunn
3aa71ee825 Update copyright in sphinxtools 2017-02-13 16:52:44 -08:00
Metallicow
58fc0d1377 Trim trailing space sphinxtools directory 2016-12-05 16:36:14 -06:00
Robin Dunn
1e448352be Take care about how wxString and wxArrayString are substituted in the docs. There are some cases where it is a substring and so should not be replaced. 2016-09-08 12:31:15 -07:00
Robin Dunn
3a3bfea166 Use just the tail of the fullname on the summary pages 2016-06-17 15:52:49 -07:00
Robin Dunn
fbe9163da8 Fix gallery links 2016-06-08 22:31:42 -07:00
Robin Dunn
2147270817 Fix generation of gallery page (issue was due to change to fullnames) 2016-06-08 10:57:15 -07:00
Robin Dunn
874bdd2626 Don't remove leading wx when postprocessing 2016-06-04 16:08:29 -07:00
Robin Dunn
68844e4b52 Add the functions to the module index pages.
Call them moduleindex pages instead of classindex.
Use the fullname for function links.
2016-05-23 23:43:11 -07:00
Robin Dunn
23c2166727 Sort using the fullname so nested classes will appear next to the parent class 2016-05-23 15:32:47 -07:00
Robin Dunn
24e2b78806 Lots more docs changes.
Add a generator that updates a persistent mapping of item (functions, classes, etc.) to the module names they are a member of.

Remove the NO_MODULE dictionary as we're tracking all the item --> module names now.

Consolidate the 2 removeWxPrefix implementations to just one.

Fix taking out too much space in the class index when removing the :ref: for unknown items, which caused ReST problems.

Use pyName if it is set

When renaming classes we also need to change the className in the method objects

Properly deal with nested classes
2016-05-22 23:39:40 -07:00
Robin Dunn
4fc2e37df7 Rename class_summary.lst extension to *.pkl for consistency 2016-05-20 19:25:03 -07:00
Robin Dunn
4c29dfae85 More copyright updates 2016-05-19 23:57:17 -07:00
Robin Dunn
a83ca5e94f Refactor lots of functions to use camelCase names 2016-05-19 23:53:40 -07:00
Robin Dunn
e2f853d0e0 Put the module docstrings on the module index pages
Plus some other changes to start using using the "wx." prefix on names in the docs. (More are still needed but this is a start.
2016-05-19 21:04:14 -07:00
Robin Dunn
97bcad804f refactor reading and writing data to pickle files 2016-05-18 21:39:21 -07:00
Robin Dunn
7f86b9eb54 It's not a subversion revision anymore. Also a bit of text tweaking. 2015-02-05 21:33:16 -08:00
Robin Dunn
87b92b66f0 Remove unnecessary #! lines from files that will never be executed standalone. 2015-02-05 21:19:32 -08:00
Robin Dunn
a75e5adb71 fix another getSvnRev 2015-02-04 14:17:58 -08:00
Andrea Gavana
e04cab6d11 Phoenix docs: avoid Sphinx errors while making the class index for a package (see previous errors on wxGrid).
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@75851 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-02-09 12:56:02 +00:00
Robin Dunn
3ab0303ac8 Restructure the page headers and how they are tweaked so we don't
have the weird wrapping problems, unless the user has a weirdly
sized browser.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@75774 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2014-02-02 06:22:36 +00:00
Andrea Gavana
cd4a234851 Phoenix: add snippets and overview for the wx.grid module.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@73513 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-02-13 15:58:36 +00:00
Robin Dunn
35fd2e16bf Update copyright year
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@73416 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-01-21 02:13:03 +00:00
Andrea Gavana
9decb82713 Phoenix: Revise the way `:param: and :rtype: are handled in sphinx_generator.py so that the module name does not appear in front of the class. Minor cleanups to the docstrings generators. Fixed interlinks in wx.lib.busy.py and wx.lib.softwareupdate.py`.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@73137 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-12-06 20:33:39 +00:00
Andrea Gavana
66840744d2 Phoenix: few corrections to the overviews; Added some more contributed snippets; Fixed some more converted snippets; Added the correct interlink references in the etg files; better handling of the Doxygen stuff.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@73135 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-12-05 20:44:52 +00:00
Andrea Gavana
6157b2bc35 Phoenix: sizers_overview.rst expanded; added a bunch of "contributed" snippets on various classes/methods; many fixes on strange doxygen layouts and XML hierarchies; fixed many cross-references between classes/methods/functions in the etg files.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@73128 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-12-04 20:58:27 +00:00
Andrea Gavana
b117617572 Phoenix: few additional fixes to some of the samples, plus better formatting for the remaining troublesome docs classes.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@73114 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-12-03 20:50:04 +00:00
Andrea Gavana
604b778a2c Phoenix docs: handle funny-formatted heading sections for window styles, extra styles and event handling; Add missing modules in the main.html Sphinx file; Convert some more snippets, specifying the highlight language used (XML/HTML for some snippets in wx.html); Correctly reference classes and functions in wx.Bitmap pure-Python methods.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@73069 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-11-30 20:54:13 +00:00
Robin Dunn
0914614515 Add code to make the inheritance diagrams able to be toggled between shown and hidden.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@72141 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-07-19 01:22:28 +00:00
Andrea Gavana
b5fcfba543 Phoenix:
- Handle the `typedef` stuff as classes when the `docAsClass` attribute is set to ``True`` in the documentation building process (see `ScrolledWindow` and `ScrolledCanvas`).

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71732 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-06-12 22:08:35 +00:00
Andrea Gavana
3e720e2530 Phoenix:
- Correctly handle and reference inherited methods inside class/method descriptions;
- Reformat the method's short descriptions in the Summary tables to properly show hyperlinks to the methods themselves.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71720 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-06-12 20:34:13 +00:00
Andrea Gavana
9233e2747b Phoenix:
- Add support for `wx.adv.Wizard` and its related classes.



git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71714 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-06-10 21:08:29 +00:00
Andrea Gavana
c56045244f Phoenix:
- Update the `sphinx_generator.py` to handle the latest `sashwin.py` and `laywin.py`;
- Remove non-pertinent sections from the wxWidgets docs (stuff talking about cpp/h include files);
- Optimize the handling of enumeration stuff thus reducing the number of unreferenced classes.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71609 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-05-30 19:06:06 +00:00
Andrea Gavana
4fee2a598a Phoenix:
- 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
2012-05-29 20:11:36 +00:00
Robin Dunn
2011586fa0 Use codecs.open in textfile_open() for Py2.7 so it can work more like open() in Py3, auto-converting to/from utf-8 and unicode. Use textfile_open in parts of the sphinx command that were having encoding errors and also in writeIfChanged().
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71564 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-05-25 20:43:48 +00:00
Robin Dunn
79f6e60a7b * Refactor the code for getting the svn revision so it can be shared.
* Refactor the code for uploading files to the nightly server to its own helper function.
* Add command to build and upload a docs tarball.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71231 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-19 03:04:04 +00:00
Robin Dunn
f404c31784 set svn:eol-style property to native
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71161 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-10 03:16:37 +00:00
Andrea Gavana
a2abfbb2f0 Phoenix:
- Add support for tooltips over inheritance diagram boxes containing the first line(s) of documentation instead of simply the default useless class name.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71160 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-09 23:00:41 +00:00
Andrea Gavana
e262cef61a Phoenix:
1. Add a substitution of the |SVN| string using subprocess;
2. Add the latest ArtProvider stuff (and replace `ArtID` and `ArtClient` parameter types with `string`). 

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71149 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-08 11:13:07 +00:00
Andrea Gavana
d44af0e4f4 Phoenix: new updates to better handle wx.lib documentation.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71121 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-06 18:22:52 +00:00
Andrea Gavana
77338050a0 Phoenix:
- First stub at integrating `wx.lib` (116 warnings);
- Added `internationalization.rst` file from Werner (with a cool sample app as well);
- Added new samples for AffineMatrix2D.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71099 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-05 18:28:47 +00:00
Andrea Gavana
94c66c0a34 Phoenix updates:
1) Keep the sidebar always visible;
2) Put the search stuff on the scrolling header;
3) Implement accordion-style JavaScrip stuff to show/hide user-contributed samples;
4) Minor clean-ups.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71087 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-03 18:41:48 +00:00
Andrea Gavana
a76c594a58 Phoenix: fixed few issues on the gallery and on parameter types.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71083 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-02 22:07:08 +00:00
Andrea Gavana
721cf235ae Phoenix: fixed few issues on the parameters hyperlinks
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71082 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-02 19:45:44 +00:00
Andrea Gavana
ab4c250c14 Phoenix: Minor tweaks to postprocess.py
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71073 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-01 21:10:53 +00:00
Andrea Gavana
aed67e3c7b git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71072 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 2012-04-01 21:01:09 +00:00
Andrea Gavana
dfc8c5e69f Phoenix stuff:
1) Fixes on the problems reported by Werner on wx.EvtHandler (and there were many others, hopefully they should be OK now);
2) Integration of Chris' samples on wx.GridBagSizer (see http://xoomer.virgilio.it/infinity77/Phoenix/GridBagSizer.html#gridbagsizer);
3) Start on the Documentation guidelines (see http://xoomer.virgilio.it/infinity77/Phoenix/DocstringsGuidelines.html);
4) Integration of Werner's patches on _core.py and app.py for the docstrings.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71071 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-04-01 17:56:57 +00:00
Andrea Gavana
003fb0a804 Phoenix:
1) Update documentation generator for `InfoBar`, `ListCtrl` and new additions;
2) Correct the `writeIfChanged` method, we can't use `str(text)` if the wxWidgets docs contain non-ascii compliant docstrings. Just treat them as unicode objects and use `codecs.open` to compare existing files with new docstrings;
3) Add empty stubs for the `ListCtrl Overview` and `Internationalization`, hopefully someone will populate them...
4) Small fix to the `MigrationGuide.txt`.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@71031 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-03-27 20:54:15 +00:00
Andrea Gavana
47aa4014fa Phoenix: update the sphinx_generator.py file and correct the Sphinx documentation for missing image header, unwanted sections in wx.TextCtrl and other minor cosmetic adjustments.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@70743 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-02-28 22:18:11 +00:00
Robin Dunn
474de882a8 * Run the sphinx command directly instead of going through their batch or Makefile.
* Output the html files to docs/html
* Clean more in clean_sphinx

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@70239 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2012-01-02 22:03:17 +00:00
Robin Dunn
f09b4b4aac More checks for newer/changed content before writing files.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxPython/Phoenix/trunk@70223 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2011-12-31 10:41:00 +00:00