search

InsightSoftwareConsortium / ITKModuleTemplate

A template to start an ITK Module
https://itk.org/ITKSoftwareGuide/html/Book1/ITKSoftwareGuide-Book1ch9.html#x50-1430009
Apache License 2.0
12 stars 16 forks source link

STYLE: Convert README from reStructuredText to Markdown #69

Closed thewtex closed 5 years ago

thewtex commented 5 years ago

With pandoc.

First step towards breaking up the ITKModuleTemplate documentation into multiple files and adding documentation on how to configure Azure Pipelines for CI / CD.

thewtex commented 5 years ago

The parameters (_fullname, email, etc.) are both in bold and italics in the reStructuredText version; if the formatting was not changed on purpose/manually, pandoc failed to apply it, and we think it makes them stand out even more, we may be willing to apply bold faces.

@jhlegarreta good eye :eagle: ! Thanks for the note! The formatting has been restored to Definition List.

BTW, will the README in the cookiecutter be also transitioned to markdown? If so, we will need to apply the conversion using the ITK utilities to the rest of remotes.

We could do this now with the template because PyPI now supports rendering Markdown README's in the package description. But, I do not think we need to bother changing existing remote modules.