Contribute examples to etsdemo #380
Conversation
I have witnessed this yesterday. Upon further investigation, it is because etsdemo has invented a triple-under |
Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com>
…nthought/envisage into contribute-examples-to-etsdemo
There was a problem hiding this comment.
LGTM.
The examples/GUI_Application is also good enough to be exposed (confirmed with @rahulporuri). That is a very simple example, and I have tested it to work with etsdemo after the folder is moved to envisage/examples/demo too. We can simply move the folder in this PR or we could also do that in a separate PR.
I also opened #381 to consider removing the other examples that still live at the top-level, which are more visible than the ones moved into envisage/examples.
Upon merging of this PR, the live documentation on docs.enthought.com/envisage will have broken links. I opened #382 to track the broken links separately. But I expect the issue to be fixed along with the upcoming release so that is no extra work needed. The issue is open merely for tracking purposes, e.g. in case the release is delayed, we might want to rebuild the documentation earlier than the release.
| "demo/*", | ||
| "demo/*/*", | ||
| "demo/*/*/*", | ||
| "demo/*/*/*/*", | ||
| "demo/*/*/*/*/*", | ||
| "demo/*/*/*/*/*/*", |
There was a problem hiding this comment.
Wait, really? Is there no concise way to do this in a single string?
There was a problem hiding this comment.
I couldn't find one. If there is a way, I'd love to know!
|
This move is making the old examples at the top level more prominent than the relevant and good ones. So if this PR goes through, I would want to make sure we have notes in |
|
The quick and dirty way to get through this is perhaps: |
This reverts commit c026040.
* remove logging from hello world and motd * remove logging from other examples * move examples into envisage * update the single URL in docs/conf.py * add examples as package_data * add entry point * flake8 * add demo folder and update package_data based off code review suggestion * Update docs/source/conf.py Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> * rename and add test for entry point * move GUI_Application example into envisage/examples * move old examples into envisage/examples/demo/legacy * Revert "move old examples into envisage/examples/demo/legacy" This reverts commit c026040. * move old examples into a new subdirectory called legacy * add a readme to reference new location for examples Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com>
* Fix index slice in ExtensionPointChangedEvent when plugin changes (#357) * Turn off macOS builds on Travis CI (#375) This PR turns off expensive macOS builds on Travis CI. We'll eventually use GitHub Actions to replace these. * update changelog with backported PRs * Make example run from any directory (#377) * Make it possible to run example scripts from anywhere. * Add a docstring for the test case * Add missing __init__.py * Import abcdefg... * Refactor documentation links to source on GitHub (#379) * Refactor external links to demo examples from extension_points.rst * Update links to github in introduction.rst * Refactor substitutions * Group substitutions * Update other references to github links * Flake8 * Remove two other links to github that point to TraitsGUI * Remove redundant newlines * Maintain all substituions in the same place * Remove two redundant lines * Contribute examples to etsdemo (#380) * remove logging from hello world and motd * remove logging from other examples * move examples into envisage * update the single URL in docs/conf.py * add examples as package_data * add entry point * flake8 * add demo folder and update package_data based off code review suggestion * Update docs/source/conf.py Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> * rename and add test for entry point * move GUI_Application example into envisage/examples * move old examples into envisage/examples/demo/legacy * Revert "move old examples into envisage/examples/demo/legacy" This reverts commit c026040. * move old examples into a new subdirectory called legacy * add a readme to reference new location for examples Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> * more changelog updates * more changes to changelog Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* Fix index slice in ExtensionPointChangedEvent when plugin changes (#357) * Turn off macOS builds on Travis CI (#375) This PR turns off expensive macOS builds on Travis CI. We'll eventually use GitHub Actions to replace these. * update changelog with backported PRs * Make example run from any directory (#377) * Make it possible to run example scripts from anywhere. * Add a docstring for the test case * Add missing __init__.py * Import abcdefg... * Refactor documentation links to source on GitHub (#379) * Refactor external links to demo examples from extension_points.rst * Update links to github in introduction.rst * Refactor substitutions * Group substitutions * Update other references to github links * Flake8 * Remove two other links to github that point to TraitsGUI * Remove redundant newlines * Maintain all substituions in the same place * Remove two redundant lines * Contribute examples to etsdemo (#380) * remove logging from hello world and motd * remove logging from other examples * move examples into envisage * update the single URL in docs/conf.py * add examples as package_data * add entry point * flake8 * add demo folder and update package_data based off code review suggestion * Update docs/source/conf.py Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> * rename and add test for entry point * move GUI_Application example into envisage/examples * move old examples into envisage/examples/demo/legacy * Revert "move old examples into envisage/examples/demo/legacy" This reverts commit c026040. * move old examples into a new subdirectory called legacy * add a readme to reference new location for examples Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> * more changelog updates * more changes to changelog Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
* Backports for 5.0.0 and update changelog (#378) * Fix index slice in ExtensionPointChangedEvent when plugin changes (#357) * Turn off macOS builds on Travis CI (#375) This PR turns off expensive macOS builds on Travis CI. We'll eventually use GitHub Actions to replace these. * update changelog with backported PRs * Make example run from any directory (#377) * Make it possible to run example scripts from anywhere. * Add a docstring for the test case * Add missing __init__.py * Import abcdefg... * Refactor documentation links to source on GitHub (#379) * Refactor external links to demo examples from extension_points.rst * Update links to github in introduction.rst * Refactor substitutions * Group substitutions * Update other references to github links * Flake8 * Remove two other links to github that point to TraitsGUI * Remove redundant newlines * Maintain all substituions in the same place * Remove two redundant lines * Contribute examples to etsdemo (#380) * remove logging from hello world and motd * remove logging from other examples * move examples into envisage * update the single URL in docs/conf.py * add examples as package_data * add entry point * flake8 * add demo folder and update package_data based off code review suggestion * Update docs/source/conf.py Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> * rename and add test for entry point * move GUI_Application example into envisage/examples * move old examples into envisage/examples/demo/legacy * Revert "move old examples into envisage/examples/demo/legacy" This reverts commit c026040. * move old examples into a new subdirectory called legacy * add a readme to reference new location for examples Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> * more changelog updates * more changes to changelog Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> Co-authored-by: Mark Dickinson <mdickinson@enthought.com> * add release date Co-authored-by: Kit Choi <kitchoi@users.noreply.github.com> Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
closes #320
replaces #359
This PR takes the steps described in this comment: #320 (comment)
It may be useful to review commit by commit as the commits generally follow each point in that comment.
Also, I tried testing the updated documentation but links result in 404 errors as the github links will not exist until after this PR is merged.
Further, at the moment, everything seems to run fine with
etsdemo(no errors / everything looks correct), but when you run the examples (e.g.hello_world.py) and navigate to the output tab in the demo application, nothing is printed. When running the example from the command line, "The hello.world application says Hola World!" is printed.(NOTE: the above happens when install etsdemo with pyside2. when trying to install with pyqt5, the application fails to launch - which seems related to enthought/pyface#418, and with wx, the application crashes once you navigate to the example file you want to run - e.g.
hello_world.py)