openforcefield / openff-qcsubmit

Automated tools for submitting molecules to QCFractal
https://openff-qcsubmit.readthedocs.io/en/latest/index.html
MIT License
26 stars 4 forks source link

Update docs #229

Closed ntBre closed 1 year ago

ntBre commented 1 year ago

Description

Update the docs conda environment to build the docs successfully, and add a couple of examples/links to the docs themselves.

Todos

Status

ntBre commented 1 year ago

@j-wags what do you think about this? Below is a screenshot of the new UnperceivableStereoFilter docs, found here. Originally I thought I would just be adding examples all over the place, but I found the inherited-members option for Sphinx, which passes along a lot of the hidden documentation that already existed from parent classes. That also let me add a seealso linking to BaseResultCollection.filter, which actually wasn't even documented before because it was only implemented on the private _BaseResultCollection.

I think the inherited-members option might be a good thing to include in all of our documentation.

image