chanzuckerberg / cryoet-data-portal

CryoET Data Portal
MIT License
19 stars 10 forks source link

docs: Add custom examples to object docstrings #1303

Open melissawm opened 2 weeks ago

melissawm commented 2 weeks ago

Adds a proof of concept implementation of custom examples for inherited class method docstrings.

For now, this only implements the custom examples for the Alignment, Annotation and AnnotationAuthor classes. If the approach is accepted I can replicate for the other objects.

Please see the deployed preview here: https://melissawm.github.io/cryoet-data-portal/python-api.html

I only changes the examples to read the specific class name instead of Run, so these examples will most likely need to be updated for text.