Improving example template

[germa89]

Improving example template and documentation.

Close #2370

[ansys-reviewer-bot]

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

[germa89]

@PipKat can I have another quick review please?

[clatapie]

LGTM! The example template can be very useful

[PipKat]

@germa89 and @clatapie I agree that this is extremely useful information, but I think we should be placing lots of what is here in the PyAnsys developer's guide and then referencing from other PyAnsys libraries when applicable. In this case, I've covered much of the content about formatting reSTructuredText files in the PyAnsys writer's guide. Earlier this week, Roberto said I should initially integrate its content into the developer's guide by creating a new tabbed section--and then, over time, we can move, reorganize, and integrate content. I just hate the thought of repeating instead of referencing because it just requires more maintenance over time!

[germa89]

@germa89 and @clatapie I agree that this is extremely useful information, but I think we should be placing lots of what is here in the PyAnsys developer's guide and then referencing from other PyAnsys libraries when applicable. In this case, I've covered much of the content about formatting reSTructuredText files in the PyAnsys writer's guide. Earlier this week, Roberto said I should initially integrate its content into the developer's guide by creating a new tabbed section--and then, over time, we can move, reorganize, and integrate content. I just hate the thought of repeating instead of referencing because it just requires more maintenance over time!

I totally agree on this, you can leave me the links to the guides where these topics are detailed and I will add/replace when needed.
If these information is not yet contained in the guides, I would add them and then delete them when available.