STYLE: Change examples README file extension to markdown

[jhlegarreta]

Change examples README file extension to markdown.

[codecov]

Codecov Report

Merging #142 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #142   +/-   ##
=======================================
  Coverage   87.93%   87.93%           
=======================================
  Files          17       17           
  Lines        4145     4145           
  Branches      514      514           
=======================================
  Hits         3645     3645           
  Misses        363      363           
  Partials      137      137

[skoudoro]

Hi @jhlegarreta,

Did you check if sphinx-gallery is happy with this change? Did you try to generate the documentation? Thank you for your feedback

[jhlegarreta]

I have not @skoudoro . The equivalent file in DIPY is also a Markdown file, and in the Sphinx gallery transition PR they are reSructuredText files.

May be the Azure CI pipelines could be taught to build the documentation to test such changes?

[skoudoro]

The doc generation is already on Travis. There is no problem during the compilation but I do not know if it is visually correct. There are often many surprises and a visual check is always necessary.

I would love to see people starting to have this habit to generate the documentation on their own laptop to check if everything is ok visually since the generation takes only 30sec (at the opposite of DIPY 😄)

[skoudoro]

As you can see here on Travis, documentation generation is failing. Can you have a look to see why @jhlegarreta?
Thanks

[jhlegarreta]

Thanks @skoudoro ! Following your note I tried to build the docs locally and got the same error, so I will close this PR and open a new one transitioning to reSructuredText.

[jhlegarreta]

PR #144 proposes the transition to reStructuredText.