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

Doc generation under Windows #1915

Merged
merged 19 commits into from Jul 25, 2019

Conversation

@skoudoro
Copy link
Member

commented Jul 19, 2019

The goal of this PR is to permit the doc generation under windows.

I use the opportunity to fix many warning during the doc generation like:

  • Unknow Field Note instead of Notes
  • Fix some link
  • Fix docstring style
@pep8speaks

This comment has been minimized.

Copy link

commented Jul 19, 2019

Hello @skoudoro, Thank you for updating !

Line 109:81: E501 line too long (98 > 80 characters)

Comment last updated at 2019-07-24 19:24:26 UTC
@codecov-io

This comment has been minimized.

Copy link

commented Jul 20, 2019

Codecov Report

Merging #1915 into master will increase coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1915      +/-   ##
==========================================
+ Coverage   85.42%   85.44%   +0.01%     
==========================================
  Files         119      119              
  Lines       14296    14296              
  Branches     2242     2242              
==========================================
+ Hits        12213    12215       +2     
+ Misses       1575     1574       -1     
+ Partials      508      507       -1
Impacted Files Coverage Δ
dipy/viz/regtools.py 36.79% <ø> (ø) ⬆️
dipy/tracking/_utils.py 92% <ø> (ø) ⬆️
dipy/denoise/noise_estimate.py 79.12% <ø> (ø) ⬆️
dipy/reconst/dti.py 96.49% <ø> (ø) ⬆️
dipy/denoise/gibbs.py 100% <ø> (ø) ⬆️
dipy/reconst/mapmri.py 90.33% <ø> (ø) ⬆️
dipy/tracking/streamline.py 92.95% <ø> (ø) ⬆️
dipy/direction/peaks.py 83.49% <ø> (ø) ⬆️
dipy/tracking/utils.py 88.95% <ø> (ø) ⬆️
dipy/tracking/life.py 97.77% <ø> (ø) ⬆️
... and 12 more

@skoudoro skoudoro changed the title [WIP] Doc generation under Windows Doc generation under Windows Jul 22, 2019

@skoudoro

This comment has been minimized.

Copy link
Member Author

commented Jul 22, 2019

Ok, this PR is done and ready to be reviewed!

1 similar comment
@skoudoro

This comment has been minimized.

Copy link
Member Author

commented Jul 22, 2019

Ok, this PR is done and ready to be reviewed!

@skoudoro

This comment has been minimized.

Copy link
Member Author

commented Jul 22, 2019

Can you restart Appveyor @arokem? Thank you?

@arokem
Copy link
Member

left a comment

This all looks good to me. Small comment on the use of "e.g." . Why was "Example" not a good word there? Does it trigger a sphinx warning?

@@ -720,7 +720,7 @@ def __init__(self, gtab, fit_method="WLS", return_S0_hat=False, *args,
is advisable to keep an eye on memory consumption as this value is
increased.
Example : In :func:`iter_fit_tensor` we have a default step value of
e.g.: In :func:`iter_fit_tensor` we have a default step value of

This comment has been minimized.

Copy link
@arokem

arokem Jul 24, 2019

Member

The phrase "e.g." should always be followed by a comma. And in this case, capitalized, as it's in the beginning of a sentence.

dipy/reconst/dti.py Outdated Show resolved Hide resolved
Update dipy/reconst/dti.py
Co-Authored-By: Ariel Rokem <arokem@gmail.com>
skoudoro added 2 commits Jul 24, 2019
@skoudoro

This comment has been minimized.

Copy link
Member Author

commented Jul 24, 2019

Why was "Example" not a good word there? Does it trigger a sphinx warning?

Yes, it triggers a warning. As soon as it differs from Numpydoc standard, we get a warning with Sphinx and or documentation generation can be impacted.

@arokem

This comment has been minimized.

Copy link
Member

commented Jul 25, 2019

OK. Off we go!

@arokem arokem merged commit a3649ef into nipy:master Jul 25, 2019

5 checks passed

Codacy/PR Quality Review Up to standards. A positive pull request.
Details
codecov/patch 100% of diff hit (target 85.42%)
Details
codecov/project Absolute coverage decreased by -0.02% but relative coverage increased by +14.57% compared to 533ce29
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@skoudoro skoudoro deleted the skoudoro:windows-doc-gen branch Jul 25, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.