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: Fix examples documentation generation warnings #1907

Merged

Conversation

@jhlegarreta
Copy link
Contributor

commented Jul 17, 2019

Fix examples documentation generation warnings.

Fixes:

WARNING: Title overline too short.

and

/doc/examples_built/viz_bundles.rst:209: WARNING: Error in "figure"
directive:
invalid option block.

.. figure:: bundle5.png
   :align: center
   **Color every streamline by the length of the streamline **

warnings reported in
https://buildd.debian.org/status/fetch.php?pkg=dipy&arch=s390x&ver=0.14.0-1&stamp=1526401155&raw=0

Take advantage of the commit to increase consistency in titles:

  • Use the same pattern for sections.
  • Limit punctuation characters to the length of the text.
DOC: Fix examples documentation generation warnings
Fix examples documentation generation warnings.

Fixes:
```
WARNING: Title overline too short.
```

and
```
/doc/examples_built/viz_bundles.rst:209: WARNING: Error in "figure"
directive:
invalid option block.

.. figure:: bundle5.png
   :align: center
   **Color every streamline by the length of the streamline **
```

warnings reported in
https://buildd.debian.org/status/fetch.php?pkg=dipy&arch=s390x&ver=0.14.0-1&stamp=1526401155&raw=0

Take advantage of the commit to increase consistency in titles:
- Use the same pattern for sections.
- Limit punctuation characters to the length of the text.
@jhlegarreta

This comment has been minimized.

Copy link
Contributor Author

commented Jul 17, 2019

@skoudoro I assume that these warnings still exist, even if the referred build is one year old. e.g. the figure in the Show every streamline of a bundle with a different color section in the Visualize bundles and metrics on bundles example is still not shown in the on-line doc.

I have not build locally the docs, so please check if the commit effectively addresses the issues. Thanks

@codecov-io

This comment has been minimized.

Copy link

commented Jul 18, 2019

Codecov Report

❗️ No coverage uploaded for pull request base (master@5196d0b). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #1907   +/-   ##
=========================================
  Coverage          ?   85.41%           
=========================================
  Files             ?      119           
  Lines             ?    14310           
  Branches          ?     2249           
=========================================
  Hits              ?    12223           
  Misses            ?     1577           
  Partials          ?      510
@skoudoro

This comment has been minimized.

Copy link
Member

commented Jul 18, 2019

ok, Thank you for this PR @jhlegarreta, I will look into it and give you a feedback asap

@skoudoro

This comment has been minimized.

Copy link
Member

commented Jul 19, 2019

Tested on a local doc build, and many warning disappear. Thank you @jhlegarreta!

@skoudoro skoudoro merged commit 1d34ebd into nipy:master Jul 19, 2019

5 checks passed

Codacy/PR Quality Review Up to standards. A positive pull request.
Details
codecov/patch Coverage not affected.
Details
codecov/project No report found to compare against
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@jhlegarreta jhlegarreta deleted the jhlegarreta:FixDocGenerationWarningsInExamples branch Jul 19, 2019

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