Verify if ESS 4.1 builds are properly linking to page anchors in help documentation (Trac #777) #886
Description
In local builds of 4.1 some Help buttons on GUIs are ignoring page anchors in the Wx code in the .py files and are only linking to the top of a given help file. Whereas in release 3.1.2 the Help button jumps to the relevant place in the help file.
In the code one often finds this comment::
Calls !DocumentationWindow with the path of the location within
the documentation tree (after /doc/ ....". Note that when using
old versions of Wx (before 2.9) and thus not the release version of
installers, the help comes up at the top level of the file as
webbrowser does not pass anything past the # to the browser when it
is running "file:///...."
However, even local builds against Wx 3.0 are failing, so it is not just a earlier Wx issue.
The behaviour of build server builds needs to be checked.
A simple way to do this is to go Fitting > Plugin Model Operations > New Plugin Model and click the Help button. If it directs you to the top of the Fitting help (you will see the title 'Fitting') the problem exists. If it directs you to New Plugin Model the build is ok.
Migrated from http://trac.sasview.org/ticket/777
{
"status": "closed",
"changetime": "2016-11-11T08:56:26",
"_ts": "2016-11-11 08:56:26.687124+00:00",
"description": "In local builds of 4.1 some Help buttons on GUIs are ignoring page anchors in the Wx code in the .py files and are only linking to the top of a given help file. Whereas in release 3.1.2 the Help button jumps to the relevant place in the help file.\n\nIn the code one often finds this comment::\n\n Calls !DocumentationWindow with the path of the location within\n the documentation tree (after /doc/ ....\". Note that when using\n old versions of Wx (before 2.9) and thus not the release version of\n installers, the help comes up at the top level of the file as\n webbrowser does not pass anything past the # to the browser when it\n is running \"file:///....\"\n\nHowever, even local builds against Wx 3.0 are failing, so it is not just a earlier Wx issue.\n\nThe behaviour of build server builds needs to be checked.\n\nA simple way to do this is to go Fitting > Plugin Model Operations > New Plugin Model and click the Help button. If it directs you to the top of the Fitting help (you will see the title 'Fitting') the problem exists. If it directs you to New Plugin Model the build is ok.\n",
"reporter": "smk78",
"cc": "",
"resolution": "fixed",
"workpackage": "SasView Bug Fixing",
"time": "2016-10-11T17:59:03",
"component": "SasView",
"summary": "Verify if ESS 4.1 builds are properly linking to page anchors in help documentation",
"priority": "critical",
"keywords": "",
"milestone": "SasView 4.1.0",
"owner": "wojciech",
"type": "defect"
}