Copy of @abhineet-gupta 's notes from #371:
This pull request implements the use of automatic documentation for documenting examples.
This is demonstrated with example-1.
Examples need to be modified so that the code is contained within a function.
Otherwise, examples get executed while building the documentation.
Also, the docstrings of other examples need to be modified to be in suitabl rst format like example-1
Type of change
What types of change is it?
Select the appropriate type(s) that describe this PR
[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (non-backwards-compatible fix or feature)
[ ] Code style update (formatting, renaming)
[ ] Refactoring (no functional changes, no API changes)
Description and Purpose
Copy of @abhineet-gupta 's notes from #371: This pull request implements the use of automatic documentation for documenting examples. This is demonstrated with example-1.
Examples need to be modified so that the code is contained within a function. Otherwise, examples get executed while building the documentation. Also, the docstrings of other examples need to be modified to be in suitabl rst format like example-1
Type of change
What types of change is it? Select the appropriate type(s) that describe this PR
TODO Items General:
TODO Items API Change:
Github issues addressed, if one exists
Examples/Testing, if applicable