Check Documentation

[Nick Draper]

Cloned from #9571:

---

Please check the documentation for these algorithms (check images, formatting etc). We have tried to allocate algorithms as fairly and sensibly as possible, but there will be some that you do not consider "yours".

There is help on how to document the algorithms in the following links: http://www.mantidproject.org/Algorithm_Documentation http://www.mantidproject.org/Algorithm_Usage_Examples And there are examples implemented for Fit, Load, LoadISISNexus and Rebin.

To create workspaces to use in your usages you should try to create the workspace using CreateSampleWorkspace or CreateWorkspace, and only use a file if you really have no other option and the size is small.

In Visual studio you have two targets to create the documentation and run the doc tests (docs-html and docs-test in a documentation subfolder). You will need to update your Third Party Library.

If you are using Linux/Mac look here: ​https://github.com/mantidproject/mantid/blob/master/Code/Mantid/docs/README.md

1. ResampleX.cpp
2. ConvertToEventWorkspace.cpp
3. AnyShapeAbsorption.cpp now in #9638
4. ApplyTransmissionCorrection.cpp
5. ChangePulsetime.cpp
6. FindPeakBackground.cpp
7. ClearMaskFlag.cpp
8. RadiusSum.cpp
9. CloneWorkspace.cpp
10. ResetNegatives.cpp
11. ModeratorTzero.cpp
12. ModeratorTzeroLinear.cpp
13. ConvertToHistogram.cpp
14. ConvertToPointData.cpp
15. SetUncertainties.cpp
16. PointByPointVCorrection.cpp
17. MaskDetectorsIf.cpp
18. CalibrateRectangularDetectors.py
19. PDDetermineCharacterizations.py
20. NexusTester.cpp
21. PDLoadCharacterizations.cpp
22. RawFileInfo.cpp
23. SaveCalFile.cpp
24. SaveIsawDetCal.cpp
25. SetSampleMaterial.cpp
26. SaveIsawQvector.cpp
27. RemoveLowResTOF.cpp

[Peter Peterson]

Removing AnyShapeAbsorption from the list

[Pete Peterson]

Re #9572. Adding images for RadiusSumInstrument.

Changeset: 34b2b394f77892367a39c15d40da84b4e399be2f

[Pete Peterson]

Re #9572. Adding images for ModeratorTzero.

Changeset: bfb1c04e3766450707f3c8bae613a43eabc625de

[Pete Peterson]

Re #9572. Updating algorithm docs.

Changeset: 330c67adfe05e31a9161191d083a5cce8eaeeb09

[Pete Peterson]

Re #9572. Removing sphinx errors.

Changeset: e4d5fee78a7e0fe64149cc102625713abfff3657

[Pete Peterson]

Re #9572. Fixing documentation markup.

Changeset: 35bcd5b1184bc35a5db389f727840fd0313aad5d

[Pete Peterson]

Merge branch 'feature/9572_documentation_check' into develop

Re #9572.

Conflicts:

Code/Mantid/docs/source/algorithms/PDLoadCharacterizations-v1.rst Code/Mantid/docs/source/algorithms/RawFileInfo-v1.rst

Changeset: b4501aaac0d1c9f88791d4d8ef54682fcca5ce2a

[Pete Peterson]

Merge remote-tracking branch 'origin/master' into feature/9572_documentation_check

Re #9572.

Conflicts:

Code/Mantid/docs/source/algorithms/PDLoadCharacterizations-v1.rst Code/Mantid/docs/source/algorithms/RadiusSum-v1.rst Code/Mantid/docs/source/algorithms/RawFileInfo-v1.rst

Changeset: 160f94ca8afc8a92d4f18bb62c9cb63fb4352089

[Pete Peterson]

Re #9572. Fixing up documentation.

Changeset: 577a0ee9828289528af3c3688a5d355a2cdbdb20

[Pete Peterson]

Merge branch 'feature/9572_documentation_check' into develop

Re #9572.

Conflicts:

Code/Mantid/docs/source/algorithms/RadiusSum-v1.rst Code/Mantid/docs/source/algorithms/RawFileInfo-v1.rst

Changeset: c47ad692785556af7c50c9a3a2218dff4b1127ff

[Pete Peterson]

Re #9572. Getting rid of last sphinx warning.

Changeset: d37d33c2ac9a51e4b56df6248179b89ba81fe3ee

[Peter Peterson]

This is on ​feature/9572_documentation_check

To test: See if there are sphinx warnings/errors in these files.

[Karl Palmen]

There is a merge conflict in RadiusSum-v1.rst that I could not resolve.

[Pete Peterson]

Merge remote-tracking branch 'origin/master' into feature/9572_documentation_check

Re #9572.

Conflicts:

Code/Mantid/docs/source/algorithms/RadiusSum-v1.rst

Changeset: e13afe017fe3933b1458bdedbf0d597915da2a43

[Peter Peterson]

Try now

[Karl Palmen]

Merge problem fixed.

[Karl Palmen]

The build of docs-test failed on Radius-Sum

4>  reading sources... [ 47%] algorithms/RadiusSum-v1
4>  reading sources... [ 47%] algorithms/RadiusSum-v1.rst.BASE
4>  ApplicationWindow-[Fatal] Fatal error on line 22 of "runsphinx_doctest.py" encountered:
4>  ApplicationWindow-[Fatal] SystemExit: 1
4>  ApplicationWindow-[Fatal]   at line 22 in 'runsphinx_doctest.py'
4>  MantidUI-[Notice] MantidPlot is shutting down...
4>  
4>  Exception occurred:
4>    File "C:\Mantid2\mantid\Code\Mantid\docs\sphinxext\mantiddoc\directives\base.py", line 24, in algorithm_name_and_version
4>      raise RuntimeError("Document filename '%s.rst' does not match the expected format: AlgorithmName-vX.rst" % docname)
4>  RuntimeError: Document filename 'RadiusSum-v1.rst.BASE.rst' does not match the expected format: AlgorithmName-vX.rst
4>  The full traceback has been saved in c:\users\kevp43\appdata\local\temp\sphinx-err-jamsa7.log, if you want to report the issue to the developers.
4>  Please also report this if it was a user error, so that a better error message can be provided next time.
4>  A bug report can be filed in the tracker at <https://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
4>C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V110\Microsoft.CppCommon.targets(172,5): error MSB6006: "cmd.exe" exited with code 1.
4>
4>Build FAILED.

[Karl Palmen]

I note that the requirement for usage examples was removed (see comment 3), so I pass this ticket even though I did not find any usage examples. Both the document builds work.

[Karl Palmen]

Merge remote-tracking branch 'origin/feature/9572_documentation_check'

Full changeset: ​35a7f5c1e87e946c7da469b026a11f08914e68dc

[Pete Peterson]

Merge branch 'feature/9572_documentation_check' into develop

Re #9572.

Conflicts:

Code/Mantid/docs/source/algorithms/PDLoadCharacterizations-v1.rst Code/Mantid/docs/source/algorithms/RawFileInfo-v1.rst

Changeset: b4501aaac0d1c9f88791d4d8ef54682fcca5ce2a

[Pete Peterson]

Merge branch 'feature/9572_documentation_check' into develop

Re #9572.

Conflicts:

Code/Mantid/docs/source/algorithms/RadiusSum-v1.rst Code/Mantid/docs/source/algorithms/RawFileInfo-v1.rst

Changeset: c47ad692785556af7c50c9a3a2218dff4b1127ff

[Stuart Campbell]

This ticket has been transferred to github issue ​10415