ewm7891: Improve mantid-related Documentation Links #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
peterfpeterson
requested changes
Nov 12, 2024
ktactac-ornl
changed the title
Co-authored-by: Pete Peterson <[email protected]>
Co-authored-by: Pete Peterson <[email protected]>
Co-authored-by: Pete Peterson <[email protected]>
peterfpeterson
approved these changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of work
dev-docs/source/AlgorithmProfiler.rstdocumentation by connecting relevant documentation for mantid and mantid-profilerdev-docs/source/images/MantidProfiler.pngSummary of work
This PR adds links to material that the reader is likely interested in, in several locations.
mantid.api.AlgoTimeRegisterdocumentation linked to reference how timing is measuredmantid-profilerREADMEis linked to point to the profiler's primary documentationPropertiesFile#algorithm-profiling-settingsis linked to point the reader to important user propertiesThe tool example image is updated as features have been added to the dashboard.
Relevant documents were previously disconnected and difficult to find.
Fixes #xxxx.
EWM 7891: Link mantid-profiler documentation
Further detail of work
To test:
Related documentation builds and displays correctly.