Deal with the algorithms that have more than 1 version

[Gesner Passos]

In the #6666, wiki_maker.py became able to deal with algorithm versioning. But, inside the Algorithm folder, I saw that only

GetEi
StripVanadiumPeaks

DiffractionFocussing
FFTSmooth
FilterByTime
FindCenterOfMassPositionQ1D
SofQW

Nick has said that we should only be showing the latest versions of the algorithms. Wiki maker should give up if the algorithm provided is not the latest version. The reasons for this are as follows:

• We don't want old versions of algorithms showing up in the search
• All algorithm dialogs would need to be changed to have the help button point to the page for the correct version of the algorithm

[Owen Arnold]

refs #6685. Single version only.

The wikimaker will only produce a wiki-page based on the most recent version of the algorithm.

Changeset: 64cea8d89a17d303a1b80f0c9083cb27f085c1cd

[Owen Arnold]

refs #6685. Single version only.

The wikimaker will only produce a wiki-page based on the most recent version of the algorithm.

Changeset: 64cea8d89a17d303a1b80f0c9083cb27f085c1cd

[Owen Arnold]

Tester:

1) Try using the wikimaker on an algorithm that has multiple versions (do not specify the --alg-version option). The wikimaker will make the page for the latest version of the algorithm. The wiki maker will also insert a note about multiple versions at the top of the wikipage.

2) Try specifying another/older version of the algorithm using the --alg-version option. The wikimaker will warn about the problem with versions, and then give-up without making/modifying any wiki pages.

Please try this out on several algorithms that have multiple versions to ensure that this is being done properly.

[Owen Arnold]

Branch for testing is ​https://github.com/mantidproject/mantid/tree/feature/6685_handle_versions

[Gesner Passos]

I found no problem in the wiki_maker it self, but, If I let this ticket to pass, than, the result on some algorithms will be disastrous (it is because the documentation of some algorithms that have 2 versions is inside the v1 file). So, a new ticket must be created, blocking this one, to ensure that the documentation of all these algorithms goes to the seccond version. The algorithms I found that may cause problems are:

• LoadRaw
• GroupDetectors
• LoadMuonNexus
• FFTSmooth
• InvertMask
• Q1D
• DiffractionFocussing
• FindCenterOfMassPosition
• RefinePowderInstrumentParameters
• FitPowderDiffPeaks
• RefinePowderInstrumentParameters

And, this one, related to other issue: wiki maker said it not registered :

• GaussianLinearBG1D

[Owen Arnold]

The fixes to the wiki maker need to get onto master in order to fix #6751, otherwise the person fixing the ticket won't be able use the wikimaker versioning changes for the fix.

Also, there is another ticket. #6751 for enabling the wikimaker. Currently the wikimaker job is disabled while these things get fixed, so there's no danger about accidentally breaking the documentation.

[Owen Arnold]

refs #6685. Single version only.

The wikimaker will only produce a wiki-page based on the most recent version of the algorithm.

Changeset: 64cea8d89a17d303a1b80f0c9083cb27f085c1cd

[Gesner Passos]

I accept the reason. As so, this ticket passed ;)

[Owen Arnold]

refs #6685. Single version only.

The wikimaker will only produce a wiki-page based on the most recent version of the algorithm.

Changeset: 64cea8d89a17d303a1b80f0c9083cb27f085c1cd

[Owen Arnold]

refs #6685. Single version only.

The wikimaker will only produce a wiki-page based on the most recent version of the algorithm.

Changeset: 64cea8d89a17d303a1b80f0c9083cb27f085c1cd

[Owen Arnold]

refs #6685. Single version only.

The wikimaker will only produce a wiki-page based on the most recent version of the algorithm.

Changeset: 64cea8d89a17d303a1b80f0c9083cb27f085c1cd

[Owen Arnold]

refs #6685. Single version only.

The wikimaker will only produce a wiki-page based on the most recent version of the algorithm.

Changeset: 64cea8d89a17d303a1b80f0c9083cb27f085c1cd

[Stuart Campbell]

This ticket has been transferred to github issue ​7531