Lerking/Phoenix
1
0
Fork 0
mirror of https://github.com/wxWidgets/Phoenix.git synced 2025-08-27 13:00:17 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity
5,973 Commits 8 Branches 22 Tags
master
Commit Graph

72 Commits

Author SHA1 Message Date
neofelis2X
78c40585d8 Docs: move a layout tweak from postprocessor to generator 2025-02-24 23:03:37 +01:00
neofelis2X
2a2179f396 Docs: update postprocessing to account for sphinx v8 2025-02-24 23:03:36 +01:00
neofelis2X
6038fc2709 Docs: fix python warning about invalid escape sequence 2025-02-24 23:03:36 +01:00
Alexandre Detiste
323e78c085 remove more Python2 hybridation 2025-02-02 20:29:49 -05:00
Edouard Choinière
7819799d0d Sort almost all usages of glob.glob for reproducible output 
This will help diff-ing logs between invocations to see what is changing when refactoring. When used for creating an archive, it will help creating a reproducible file.
 2025-01-28 03:28:11 +00:00
Tim Gates
e6c584f3fe docs: fix simple typo, repalce -> replace 
There is a small typo in sphinxtools/postprocess.py.

Should read `replace` rather than `repalce`.
 2020-12-31 08:58:38 +11:00
Robin Dunn
35931985ab Update some copyright years 2020-11-11 15:55:30 -08:00
Per A. Brodtkorb
e4e8bf8317 Fixes issue 1571: 
Adding missing close for open.
If the "close()" call is missing after a "open(filename)" call, the filename isn't guaranteed to be closed before the interpreter exits.
This is generally a bad practice as explained here: https://stackoverflow.com/questions/7395542/is-explicitly-closing-files-important

Also replaced "fid=open(filename) fid.close()" statements for files with the safer
"with open(filename) as fid:" blocks. See https://www.python.org/dev/peps/pep-0343/
 2020-03-23 17:16:44 +01:00
Per A. Brodtkorb
033c18fd9f Fixes issue #1556 
Replaced XXX.keys() calls with idiomatic python 3 calls that are compatible with python 2 such as eg:
 * replaced "y = xxx.keys()" or "y = list(xxx.keys())" with just "y = list(xxx)"
 * replaced "sorted(xxx.keys())" or "sorted(list(xxx.keys()))" with just "sorted(xxx)"
 * replaced "if not A in B.keys():" with "if A not in B:"
 * replaced "for A in B.keys():"  with "for A in B:"

See also https://python-future.org/compatible_idioms.html
https://python-future.org/compatible_idioms.html#dict-keys-values-items-as-a-list
 2020-03-20 18:51:19 +01:00
Robin Dunn
c5598d85bf Tweak links on the index pages to go to the page rather than the class 2019-10-11 12:55:22 -07:00
Robin Dunn
70be620ebb Remove the sidebar from pages in the Dash docset 2019-10-04 08:09:21 -07:00
Robin Dunn
40320294c1 Use BeautifulSoup to remove the header image instead of just changing the class. 2019-10-03 20:48:24 -07:00
Robin Dunn
09404e63f5 Simplify postprocessing, remove changes no longer needed, or edit them for Sphinx 2.2.0. 2019-10-03 14:54:50 -07:00
Robin Dunn
c3a68bef90 Use encoding when postprocessing the documentation files 2019-09-17 18:26:21 -07:00
Robin Dunn
79ddece4e9 Use forward slashes in sphinx output 
(cherry picked from commit 7b3a62102c)
 2018-11-08 20:31:30 -08:00
Robin Dunn
b77c88a280 Merge tag 'wxPython-4.0.2' into wxPy-4.0.x 
(cherry picked from commit 4c56c39e52)
 2018-06-17 22:04:22 -07:00
Metallicow
c76384d458 Trim trailing whitespace *.py files 2018-01-16 08:47:07 -06:00
infinity77
838db7bd93 These fixes should get rid of issues #485 and #440 2017-11-15 16:50:57 +01:00
Robin Dunn
f06c6533f5 Make the index be what was main.html, redirect main to index, and set the Home link to the main wxPython site. 2017-07-20 21:01:43 -07:00
Robin Dunn
37d67272b0 Generate a different welcome paragraph on main.html dependent on whether this is a release build or a snapshot build. 2017-05-10 12:42:48 -07:00
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