Auto plot images

[audrey01mit]

issues #8 and #17 (can you confirm that this is answered as you wanted?)

• Integrated plot_images in generate_api.py.
• Updated documentation accordingly
• Iterated through several options to add hooks, github workflow etc to prompt a message to the contributor asking them if they want to generate API. Ended up thinking that the API cannot be generated on a push or a commit event, as it generates itself code that needs to be added, committed and pushed. You also kind of want to check that the doc displays properly before making a pull request or merging, so it would not be enough to generate it at those times either. I do not really see how to integrate it better than simply asking the contributor to run the file when ready. Let me know your thoughts.

In any case, this is already simpler to run like that I think.

[reed-foster]

Yeah I think it's simple enough to just make people run the script to generate docs. It should be possible to write a custom pre-commit hook which runs locally before a commit and automatically runs the documentation generation script and adds all the outputs to the commit before actually finalizing the commit. But I think it's probably easiest to leave it as it is.