Skip to content
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

Add full API to documentation #615

Open
effigies opened this issue Jul 27, 2017 · 1 comment
Open

Add full API to documentation #615

effigies opened this issue Jul 27, 2017 · 1 comment

Comments

@effigies
Copy link
Member

Even if we don't have full documentation for every class yet, I think having a searchable API might be useful to some users, and it should be a pretty low cost effort with Sphinx. It will also help highlight which areas off the docs need attention.

For fmriprep.interfaces, may want to reuse nipype's population of inputs and outputs from the specs, though possibly with a little bit better formatting.

@oesteban
Copy link
Member

oesteban commented Aug 2, 2017

I was thinking of creating a sphinx extension for nipype interfaces. But it's just a wish, for this PR it makes sense just reusing nipype's current code.

@oesteban oesteban added this to To do in Documentation Mar 11, 2019
@oesteban oesteban added this to the 2.0.0 milestone Jul 11, 2019
@oesteban oesteban removed this from To do in Documentation Sep 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants