-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC] Update documentation #65
Conversation
…ng of doc using the nipype sphinx extensions
@pdedumast @hamzake Should be ready to merge this PR, waiting all tests pass and your review. In particular it includes:
We are now using the nipype sphinx extension to generate the doc of the interfaces such that it is really important to use the argument Note also another important thing with the input_images = InputMultiPath(File(), desc='Input images') Otherwise the nipype sphinx extension is not happy and the correct rendering of interface inputs and outputs breaks. Doc is rendered at https://mialsrtk.readthedocs.io/en/64_doc_singularity_v2.0.1-dev. By merging this PR and then PR #63, we will be ready to release the new version. |
List of changes:
mialsuperresolutiontoolkit
desc=
argument of all nipype input and output class attributes for correct rendering using the new nipype sphinx extension, that uses directly thedesc=
argument of all the input and output class attributes so that we do not have to describe the attributes again.