Depricated Algorithm links in Sphinx

[Owen Arnold]

The links to the 'Use Instead' algorithms aren't working out properly in the algorithm html pages generated by Sphinx. See DiffractionFocusing.

• Possibly have an additional argument on useAlgorithm() to specify the version of the algorithm to use.
• Default to the latest version of the current algorithm
• Allow the useAlgorithm to specify a completely different algorithm and have the links to that documentation properly generated.

Set against release 3.2, but completely understand if this gets moved to later.

[Martyn Gigg]

Standardize the version part of the deprecation message.

Refs #9599

Changeset: e040a2741eeaff4b23838138c70a5a0ed5416f26

[Martyn Gigg]

Update algorithm deprecation warnings in docs

Using the new standardized format we can properly link to the correct version of the algorithm that replaces the deprecated one. Refs #9599

Changeset: d8a6dcdd7aa52f88cb3a65f6f316658394a38d3a

[Martyn Gigg]

Only warn on replacement algm being invalid, rather than throwing.

We shouldn't stop the algorithm execution because of it. Refs #9599

Changeset: 30288ed4a57b3b91cde07ee78cc5526c1dce7f3e

[Martyn Gigg]

Fix useAlgorithm messages for a few DataHandling algorithms.

Refs #9599

Changeset: 184c411959053c9475990b8e828007f455f7780c

[Martyn Gigg]

Branch: ​feature/9599_standardize_alg_deprecation_msg

Tester: Build the html documentation using the docs-html target. Look at the Rebin page (build/docs/html/algorithms/Rebin.html) and check that there is no deprecation message as expected. Now find some deprecated algorithms:

• DiffractionFocussing-v1
• FindUBUsingMinMaxD
• StitchMD

and verify that for the algorithms that suggest using another algorithm, you can click the link to get to that algorithm.

[Martyn Gigg]

Fix doxygen warnings in DeprecatedAlgorithm

Refs #9599

Changeset: 54f29df96b77d1666a5cbce95323aee96521dee2

[Peter Peterson]

Merging this into master breaks the category links at the bottom of the algorithm pages. Also, it isn't rendering DiffractionFocussing-v1 with the link. Please merge master into this branch and re-close the ticket.

[Martyn Gigg]

I've merged master in. I cleaned out my built documentation tree and when I rebuilt everything I get the working links for both the deprecation and categories.

Sphinx has a habit of trying to clever and cache things so that it doesn't always rebuild. Could you try cleaning out the built stuff and then rebuilding:

rm -fr docs/doctrees
rm -fr docs/html
ninja docs-html

[Jay Rainey]

Older (deprecated) algorithms now link to their latest version correctly. Code changes are sensible & address the issue. The issue Peter noted in comment:11 no longer exists.

I did notice one style issue. The warning div expands across and behind the image, which isn't ideal. Instead, I will make a change in this branch to hide the overflow, which will make it look better (e.g. it will expand until it hits another div).

[Jay Rainey]

Prevent warning message being hidden behind image. Refs #9599.

Changeset: 995365cf2872e0a43c2f1798edc53dc83be6a0dd

[Jay Rainey]

Merge remote-tracking branch 'origin/feature/9599_standardize_alg_deprecation_msg'

Full changeset: ​c7eac2f307145f7603f8d83191ee534ee576b445

[Stuart Campbell]

This ticket has been transferred to github issue ​10442