Handle Versioning and Deprecation in WikiMaker

[Owen Arnold]

The WikiMaker gets two things wrong.

Firstly, it wipes the pages for algorithms that have been deprecated. This is not a good strategy, because the user may still want to run the deprecated algorithm, and they have no documentation help to assist them. What should happen is that you should get a clear Deprecation message and link at the top of the page, but then then all the other details about the algorithm properties, usage, description etc.

Secondly, The wiki maker does not handle versions, and there is no way to pass a version number to the algorithm. This could be better handled with a flag for the version number (if a single algorithm is passed).

[Owen Arnold]

refs #6666. Handle versioning.

Users of this script can provide a --alg-version to target a specific version of the altorighm.

Changeset: 284041ead2555dc20f51ae9fc754dfb7013caa72

[Owen Arnold]

Tester: You can check the versioning by running the wikimaker algorithm with the --alg-version option. For example, try using the wikimaker (with the --dry-run option) and --alg-version=1 on GetEi. The wikimaker should claim to be in the process of updating version 1 of the GetEi algorithm in it's console output. Do the same thing, but remove the --alg-version argument altogether and the wikimaker should claim to be updating version 2 (the latest version).

[Owen Arnold]

refs #6666 Deprecated reformat.

Changeset: 8afe437d2060ef304be1215d25978ead6fbc4f87

[Owen Arnold]

Tester, as well as the version number issue being fixed (see test comment above). The wikipage output for the deprecated algorithms should also be fixed in-line with the requirements in the original ticket description. A deprecated algorithm you might like to use to try this out is BinToMDHistoWorkspace.

[Owen Arnold]

Tester, branch is ​https://github.com/mantidproject/mantid/tree/feature/6666_versioning

Please test #6664 before checking this ticket.

[Owen Arnold]

refs #6666. Handle versioning.

Users of this script can provide a --alg-version to target a specific version of the altorighm.

Changeset: 284041ead2555dc20f51ae9fc754dfb7013caa72

[Owen Arnold]

refs #6666 Deprecated reformat.

Changeset: 8afe437d2060ef304be1215d25978ead6fbc4f87

[Owen Arnold]

refs #6666. Handle versioning.

Users of this script can provide a --alg-version to target a specific version of the altorighm.

Changeset: 284041ead2555dc20f51ae9fc754dfb7013caa72

[Owen Arnold]

refs #6666 Deprecated reformat.

Changeset: 8afe437d2060ef304be1215d25978ead6fbc4f87

[Gesner Passos]

The WikiMaker can now handle multiple version. So, the evolution of this is to use the multiple versions, I've created a ticket (#6685), because from the algorithms that has more than 1 version, just 2 shows the wiki page for both.

The Deprecated works correctly.

[Owen Arnold]

refs #6666. Handle versioning.

Users of this script can provide a --alg-version to target a specific version of the altorighm.

Changeset: 284041ead2555dc20f51ae9fc754dfb7013caa72

[Owen Arnold]

refs #6666 Deprecated reformat.

Changeset: 8afe437d2060ef304be1215d25978ead6fbc4f87

[Owen Arnold]

refs #6666. Handle versioning.

Users of this script can provide a --alg-version to target a specific version of the altorighm.

Changeset: 130e8980fe7213d025c6c8a435d381856599e235

[Owen Arnold]

refs #6666 Deprecated reformat.

Changeset: ce027eca927c49d22197c8e6a12c42ec0e328eae

[Owen Arnold]

refs #6666. Handle versioning.

Users of this script can provide a --alg-version to target a specific version of the altorighm.

Changeset: 284041ead2555dc20f51ae9fc754dfb7013caa72

[Owen Arnold]

refs #6666 Deprecated reformat.

Changeset: 8afe437d2060ef304be1215d25978ead6fbc4f87

[Stuart Campbell]

This ticket has been transferred to github issue ​7512