Skip to content

DOC:add instructions to install; fix doc build for python 3 #1478

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

Merged
merged 3 commits into from
May 24, 2016

Conversation

berleant
Copy link
Contributor

small changes to start contributing!

@satra
Copy link
Member

satra commented May 17, 2016

@shoshber - welcome to nipype.

i was recently told that the install instructions are not very evident for a lay person. since you are new to nipype, and editing the file in this PR, could you please take a look?

@berleant
Copy link
Contributor Author

@satra aye, that is exactly what I'm doing! Maybe not for a layperson, but I can provide perspective from someone who is new to the project.

@berleant
Copy link
Contributor Author

I was planning to add clarifications to the install documentation in another pull request, but I can do it in this one--is that what you are asking?

@satra
Copy link
Member

satra commented May 17, 2016

@shoshber - since i saw an install.rst change, i thought it could be done with this. but having a separate PR for it would be good.

@berleant
Copy link
Contributor Author

I'm not done testing my installation of nipype yet, but here are my thoughts so far:

  1. nibabel 2.0.1 is already in nipype's requirements.txt file. Why do the instructions say to install it separately?
  2. Setting up my development environment to build the documentation was unexpectedly difficult. Some ideas to help it go more smoothly for the next person: a) document packages that are required for development, say, in a file called requirements-developer.txt (by analogy to requirements.txt). sphinx, graphviz would be in the file. b) build documentation testing into circleci to prevent accidental commits of breaking changes

I updated install.rst with some clarifications/additional instructions. I'll add it to this pull request as soon as it finishes building.

Shoshana

@chrisgorgo
Copy link
Member

  1. pip install nipype should automatically install nibabel if it's not present. There is no need to install it manually. Maybe we should remove all dependencies that are installed automatically? They only confuse users.
  2. Documentation is already built and tested for error on CircleCI. See https://github.com/nipy/nipype/blob/master/circle.yml#L49

@mwaskom
Copy link
Member

mwaskom commented May 18, 2016

There is no need to install it manually. Maybe we should remove all dependencies that are installed automatically? They only confuse users.

I think it's good to know what kind of dependencies a package has, though I agree it should be made clear what pip will take care of.

@berleant
Copy link
Contributor Author

  1. Yeah, the Mac OS X instructions make it seem like you must install nibabel separately. I'll clarify that in the instructions.
  2. That's odd--the numpy doc would not build in python 3 until I made the changes in the commit. I'm not versed enough in circleci to check--perhaps it is only checking the build for python 2?

@berleant berleant changed the title add instructions to install; fix doc build for python 3 DOC:add instructions to install; fix doc build for python 3 May 19, 2016
@chrisgorgo chrisgorgo merged commit b323622 into nipy:master May 24, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants