Open drbenvincent opened 1 month ago
Hey @drbenvincent, Can I pick this issue?
Hi @harsha-mangena. Sounds good - but we're just about to merge a PR which is a pretty major code refactor. So we need to wait until #381 is merged first or any work done will be messed up. Can you check back toward the end of next week? It should (hopefully) be merged then.
@drbenvincent, No problem. I will check this issue next week.
It might be nice to make the api docs (auto build from the docstrings) more engaging by adding some plots. As far as I can tell, it is possible to take the code that we have in the doctests right now and also generate a plot that is rendered in the docs.
This could be relevant for the experiment classes in particular. I don't see any value in adding to the model classes for example.
Here's an example of current docs:
If we add the plot method into that code snippet, then we can get that plot to render in the built docs.
I believe (though have not verified) that we can do this as follows:
If that works as I imagine, then this will:
I have not verified that this works, but I imagine there is a way!
Notes
plt.show()
at the end.sphinx.ext.doctest
. Would need to look into this.sphinx.ext.plot_directive
to the list of extensions inconf.py
.