User friendly docs for operations #1054
Merged
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
samtygier-stfc
force-pushed
the
1052_operations_docs
branch
2 times, most recently
from
d878dbe to
e9a49c6
Compare
samtygier-stfc
changed the title
samtygier-stfc
force-pushed
the
1052_operations_docs
branch
from
1ece62c to
42ad3b8
Compare
Sphinx tries to import all the modules, so they need to not raise exceptions at import time.
Use the class docstring plus the parameter list from the filter_func.
Updates from feeback from Winfried
The help button in the operations window now links to the new user docs. THe new docs have a link to the API docs if needed.
samtygier-stfc
force-pushed
the
1052_operations_docs
branch
from
a7b1490 to
effe368
Compare
mantidimaging/core/operations/remove_dead_stripe/remove_dead_stripe.py
Outdated
Show resolved
Hide resolved
mantidimaging/core/operations/roi_normalisation/roi_normalisation.py
Outdated
Show resolved
Hide resolved
Makes more sense (avoiding a divide by zero) and is functionally identical
StephenNneji
approved these changes
Jul 21, 2021
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.
Issue
Closes #898
(note the number is the branch name is wrong)
Description
Add extension to generate user friendly documentation for operations. Takes the docstring for the class, and the parameters from the
filter_funcmethod (with some standard parameters removed).Update doc strings for operations
Also: Move test skipping into decorators to avoid errors with sphinx
Testing & Acceptance Criteria
To build the docs locally run:
python3 ./setup.py docsDocs will be written to docs/build/html , so for me operations docs are in ~/git/mantidimaging/docs/build/html/user_guide/operations/index.html
Help button in the operations window should link to something like https://mantidproject.github.io/mantidimaging/user_guide/operations/index.html#crop-coordinates
Documentation
Updated release notes