PSyclone icon indicating copy to clipboard operation
PSyclone copied to clipboard

Create UG examples documentation from the respective MarkDown READMEs

Open arporter opened this issue 3 years ago • 1 comments

At the moment we have to document the examples twice - once in doc/user_guide/examples.rst and again in the appropriate README.md under the examples directory. In #1669 @hiker suggested finding a way of removing this duplication.

I've googled and it looks as though https://github.com/CrossNox/m2r2 is the answer - it converts MD to RST and allows the results to be included in an existing RST file.

arporter avatar Jun 13 '22 11:06 arporter

This would also be useful in the PSyAD documentation where the Examples section is sparse but there's a lot of content in the READMEs.

arporter avatar Oct 17 '22 11:10 arporter