Add documentation for toolkit/backend selection#597
Conversation
aaronayres35
left a comment
aaronayres35
left a comment
There was a problem hiding this comment.
Changes LGTM, I built the docs locally and everything looked as expected. Links to ETSConfig in traits don't seem to actually give a link, but I don't think that is the fault of the changes in this PRR
| --------- | ||
|
|
||
| To control toolkit selection directly from application code, one must use | ||
| :class:`~traits.etsconfig.etsconfig.ETSConfig`. Specifically, the |
There was a problem hiding this comment.
For some reason when I built the docs this doesn't link to https://docs.enthought.com/traits/traits_api_reference/traits.etsconfig.html?highlight=etsconfig#traits.etsconfig.etsconfig.ETSConfig
It just shows up bolded. The Pyface link to Toolkit further down works as expected.
There was a problem hiding this comment.
I believe this is and the intersphinx_mapping given above are correct though, so it may be unrelated to the changes here
There was a problem hiding this comment.
I noticed that too. I'm not sure why it doesn't work.
| explicitly specified. | ||
|
|
||
|
|
||
| ETSConfig |
There was a problem hiding this comment.
Not a suggested change:
It makes sense to have this section here, but some of this content should also happily sit in the traits docs. Currently the traits docs (outside of api documentation) have little to no mention of ETSConfig.
There was a problem hiding this comment.
Ref: enthought/traits#1427
When writing the traits docs in the future it may be useful to reference these docs / vice-versa
There was a problem hiding this comment.
Agree. Glad there's an issue in traits already.
|
Thanks for the quick review |
3 participants
The banner feature here is an explanation of the
ETS_TOOLKIT/ETSConfig.toolkitmechanism for selecting the GUI toolkit and kiva backend used by an application. In addition to that, I made some minor additions/modifications in other parts of the documentation.