Add algorithm usage examples #10458
Labels
Documentation
Issues and pull requests related to documentation
High Priority
An issue or pull request that if not addressed is severe enough to postponse a release.
Milestone
Cloned from http://trac.mantidproject.org/mantid/ticket/9614:
Cloned from http://trac.mantidproject.org/mantid/ticket/9580:
A dd testable algorithm usage examples.
There is help on how to document the algorithms in the following links:
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
The text was updated successfully, but these errors were encountered: