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
d786a1dc1a
Fix html tags around the inheritance diagram so BeautifulSoup doesn't get confused.
2019-10-03 20:00:16 -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
4a506f82a6
Python2 doesn't have ClassMethodDescriptorType, but the build slaves are stuck on Py2 for now.
2019-09-14 19:03:41 -07:00
Robin Dunn
fa4683d8f7
* Fix scanning extension modules for docstrings
...
* Support documenting classes that are in a package's __init__ module
2019-09-04 14:31:01 -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
Robin Dunn
693863c2a5
Merge pull request #762 from mesalu/admonish_deprecation
...
Admonish deprecations
2018-02-22 22:08:02 -08:00
Robin Dunn
87d7edab83
Lots of changes needed to get things building again after switching to wxWidgets master
2018-02-09 15:15:01 -08: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
8f238ad594
Begin adding wrappers for wx.aui
2016-10-25 19:19:08 -07: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
5c79d5ccec
Merge branch 'master' into propgrid
2016-08-24 14:31:12 -07:00
Robin Dunn
25d687d8a3
Convert some code snippets for the docs.
2016-08-13 17:33:33 -07:00
Robin Dunn
73b2e45156
More progress on propgrid classes
2016-08-13 12:30:44 -07:00
Robin Dunn
4732fcdf18
Various documentation fixes for PseudoDC
2016-07-29 18:56:03 -07:00
Robin Dunn
9bcccff097
If a property's getter has a docstring, use it.
2016-07-23 00:25:08 -07:00
Robin Dunn
2251338f03
Merge branch 'master' into add-ribbon-lib
2016-07-01 20:24:07 -07:00
Robin Dunn
ed4756b902
Remove wx.lib.six and use the stock six module instead,
...
and add it as an installation dependency.
2016-06-30 20:07:57 -07:00
Robin Dunn
d0f79d62df
Add missing '.' in wx.ribbon. module names
2016-06-24 19:59:25 -07:00
Robin Dunn
8742967677
Start adding wrappers for the wx.ribbon module
2016-06-21 20:30:30 -07:00
Robin Dunn
5983df8a5f
Generate attribute docs for exposed C++ attributes like properties.
2016-06-17 16:01:38 -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
dd35a4f948
Add header comment to the generated ReST files
2016-06-10 09:25:36 -07:00
Robin Dunn
ddfbc17469
Fix names of base classes in Python classes when the base is from the binary modules.
2016-06-09 16:02:45 -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
664d5b765a
Fixes for inheritance diagrams
2016-06-08 00:31:10 -07:00
Robin Dunn
af7176bbd9
Put all three elements back in the all_classes dict,
...
even though we're not using them all, it's just easier for now.
2016-06-07 19:29:34 -07:00
Robin Dunn
d7e4f7c22b
Use fullnames in the inheritance diagrams, with some related fixes.
2016-06-07 16:43:46 -07:00
Robin Dunn
cfed6ce4df
Various updates to use fullnames in wx.lib, fix links back to the compiled modules, various source cleanup, etc.
2016-06-07 16:43:04 -07:00
Robin Dunn
4fb5b54331
Add more excluded attrs for Py3
2016-06-07 16:33:13 -07:00
Robin Dunn
874bdd2626
Don't remove leading wx when postprocessing
2016-06-04 16:08:29 -07:00
Robin Dunn
2355ceb198
Use fullname on constants in the converted text
2016-06-04 14:44:08 -07:00
Robin Dunn
be90ee5427
Fix incorrect doubling on ** in some cases.
...
More nested enum fixes.
2016-05-27 14:57:57 -07:00
Robin Dunn
045773b119
Try without the currentmodule directive...
2016-05-24 23:40:58 -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
94d9f61852
Remove "Classes" from the module index title.
...
I think just the module name is good enough.
2016-05-23 14:53:21 -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
