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
Merged

Doc generation under Windows #1915

merged 19 commits into from Jul 25, 2019

Conversation

skoudoro
Copy link
Member

@skoudoro skoudoro 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
Copy link

pep8speaks 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
Copy link

codecov-io 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
Copy link
Member Author

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

1 similar comment
@skoudoro
Copy link
Member Author

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

@skoudoro
Copy link
Member Author

Can you restart Appveyor @arokem? Thank you?

Copy link
Contributor

@arokem arokem left a comment

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Choose a reason for hiding this comment

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

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
Co-Authored-By: Ariel Rokem <arokem@gmail.com>
@skoudoro
Copy link
Member Author

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
Copy link
Contributor

arokem commented Jul 25, 2019

OK. Off we go!

@arokem arokem merged commit a3649ef into dipy:master Jul 25, 2019
@skoudoro skoudoro deleted the windows-doc-gen branch July 25, 2019 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants