Thanks to visit codestin.com
Credit goes to github.com

Skip to content

MRG: Improve doc #205

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 2 commits into from
Sep 26, 2017
Merged

MRG: Improve doc #205

merged 2 commits into from
Sep 26, 2017

Conversation

larsoner
Copy link
Contributor

@larsoner larsoner commented Jul 31, 2017

Closes #199.

Todo:

Still need to make sure the rest of the issues in there are addressed. In the meantime, the first commit fixes the vector example build (wouldn't work on OSX -- figures are closed at the end of each SG section).

@larsoner larsoner mentioned this pull request Aug 3, 2017
@larsoner larsoner changed the title WIP: Improve doc MRG: Improve doc Aug 7, 2017
@larsoner
Copy link
Contributor Author

larsoner commented Aug 7, 2017

Ready for review/merge from my end. Updated docs here.

@larsoner larsoner changed the title MRG: Improve doc WIP: Improve doc Aug 8, 2017
@larsoner
Copy link
Contributor Author

larsoner commented Aug 8, 2017

Setting back to WIP because the SG names may change. But still ready for review / perusal of the doc because that shouldn't change.

@larsoner larsoner changed the title WIP: Improve doc MRG: Improve doc Sep 25, 2017
@larsoner
Copy link
Contributor Author

Okay this one should be good to go. Includes a small fix for Travis.

brain.screenshot()
if not sys.platform.startswith('linux') or \
os.getenv('TRAVIS', 'false') != 'true':
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so this will not run on any linux system ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It runs fine on my local Linux, I'm assuming it's an Xvfb / temporary Mayavi bug

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you're asking about the conditional -- these lines will run if the system is not linux or it's not travis (same as not (linux and travis))

@agramfort
Copy link
Contributor

agramfort commented Sep 25, 2017 via email

@larsoner
Copy link
Contributor Author

Okay with you @mwaskom?

@@ -1186,7 +1186,7 @@ def add_annotation(self, annot, borders=True, alpha=1, hemi=None,
hemisphere, i.e. ``annot=(labels, ctab)`` for a single hemisphere
or ``annot=((lh_labels, lh_ctab), (rh_labels, rh_ctab))`` for both
hemispheres. ``labels`` and ``ctab`` should be arrays as returned
by :func:`nibabel.freesurfer.read_annot`.
by :func:`nibabel.freesurfer.io.read_annot`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is nibabel changing its imports? nib.freesurfer.read_annot has always worked for me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is probably imported both places, but this is where it lives in their docs (sphinx index) so this is necessary for it to link properly.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah got it.

@mwaskom
Copy link
Member

mwaskom commented Sep 26, 2017

I don't have time to build the docs and look but the code changes seem good. Note the one comment.

@larsoner larsoner merged commit 4ba5220 into nipy:master Sep 26, 2017
@larsoner
Copy link
Contributor Author

Thanks for the looks, I'll work on cutting a release now

@larsoner larsoner deleted the fix-doc branch September 26, 2017 18:18
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.

Issues with new sphinx-gallery examples
3 participants