Ticket #9572 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation

Reported by: Nick Draper Owned by: Peter Peterson
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: #9610 Tester: Karl Palmen

Description (last modified by Peter Peterson) (diff)

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

Change History

comment:1 Changed 6 years ago by Nick Draper

  • Summary changed from Check Documentation and add algorithm usage examples (cloned) (cloned) (cloned) (cloned) to Check Documentation and add algorithm usage examples

comment:2 Changed 6 years ago by Nick Draper

  • Status changed from new to assigned
  • Owner changed from Andrei Savici to Peter Peterson
  • Description modified (diff)

comment:3 Changed 6 years ago by Peter Peterson

  • Description modified (diff)
  • Blocking 9610 added

comment:4 Changed 6 years ago by Peter Peterson

  • Summary changed from Check Documentation and add algorithm usage examples to Check Documentation

comment:5 Changed 6 years ago by Peter Peterson

  • Description modified (diff)

comment:6 Changed 6 years ago by Peter Peterson

  • Status changed from assigned to inprogress

comment:7 Changed 6 years ago by Peter Peterson

  • Description modified (diff)

Removing AnyShapeAbsorption from the list

comment:8 Changed 6 years ago by Pete Peterson

Re #9572. Adding images for RadiusSumInstrument.

Changeset: 34b2b394f77892367a39c15d40da84b4e399be2f

comment:9 Changed 6 years ago by Pete Peterson

Re #9572. Adding images for ModeratorTzero.

Changeset: bfb1c04e3766450707f3c8bae613a43eabc625de

comment:10 Changed 6 years ago by Pete Peterson

Re #9572. Updating algorithm docs.

Changeset: 330c67adfe05e31a9161191d083a5cce8eaeeb09

comment:11 Changed 6 years ago by Pete Peterson

Re #9572. Removing sphinx errors.

Changeset: e4d5fee78a7e0fe64149cc102625713abfff3657

comment:12 Changed 6 years ago by Pete Peterson

Re #9572. Fixing documentation markup.

Changeset: 35bcd5b1184bc35a5db389f727840fd0313aad5d

comment:13 Changed 6 years ago by 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

comment:14 Changed 6 years ago by 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

comment:15 Changed 6 years ago by Pete Peterson

Re #9572. Fixing up documentation.

Changeset: 577a0ee9828289528af3c3688a5d355a2cdbdb20

comment:16 Changed 6 years ago by 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

comment:17 Changed 6 years ago by Pete Peterson

Re #9572. Getting rid of last sphinx warning.

Changeset: d37d33c2ac9a51e4b56df6248179b89ba81fe3ee

comment:18 Changed 6 years ago by Peter Peterson

  • Status changed from inprogress to verify
  • Resolution set to fixed

This is on feature/9572_documentation_check

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

comment:19 Changed 6 years ago by Karl Palmen

  • Status changed from verify to verifying
  • Tester set to Karl Palmen

comment:20 Changed 6 years ago by Karl Palmen

  • Status changed from verifying to reopened
  • Resolution fixed deleted

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

comment:21 Changed 6 years ago by Pete Peterson

  • Status changed from reopened to inprogress

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

Re #9572.

Conflicts:

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

Changeset: e13afe017fe3933b1458bdedbf0d597915da2a43

comment:22 Changed 6 years ago by Peter Peterson

  • Status changed from inprogress to verify
  • Resolution set to fixed

Try now

comment:23 Changed 6 years ago by Karl Palmen

  • Status changed from verify to verifying

comment:24 Changed 6 years ago by Karl Palmen

Merge problem fixed.

comment:25 Changed 6 years ago by Karl Palmen

  • Status changed from verifying to reopened
  • Resolution fixed deleted

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.

comment:26 Changed 6 years ago by Peter Peterson

  • Status changed from reopened to verify
  • Resolution set to fixed

comment:27 Changed 6 years ago by Karl Palmen

  • Status changed from verify to verifying

comment:28 Changed 6 years ago by 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.

comment:29 Changed 6 years ago by Karl Palmen

  • Status changed from verifying to closed

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

Full changeset: 35a7f5c1e87e946c7da469b026a11f08914e68dc

comment:30 Changed 6 years ago by 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

comment:31 Changed 6 years ago by 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

comment:32 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10415

Note: See TracTickets for help on using tickets.