QCFractal
QCFractal copied to clipboard
pydantic model docs, objects.inv, aftermath removing qcel autodoc
Description
Changelog description
- [x] remove use of qcel autodoc and
__base_doc__in qcf code that were removed in MolSSI/QCElemental#289 - [x] add use of https://github.com/mansenfranzen/autodoc_pydantic by replacing
.. autoclass::with.. autopydantic_model::. hopefully I didn't miss any. - [x] for qcportal docs, I added
FractalClientso the class would appear inobjects.inv. I removed Mol so thatqcelemental.models.Moleculedidn't appear inobjects.inv. there's still a couple qcel refs in there, but they're to Protocols that aren't acutally exported by qcel, and I didn't want to change code. - [x] updated sphinx autodoc options, updated intersphinx, effectively switched main build to rtd.
- [ ] I can't see how the docs build is going to go, but both qcportal and qcfractal docs builds work fine for me locally. here's a GHA docs build snippet (https://github.com/MolSSI/QCElemental/blob/master/.github/workflows/CI.yml#L81) but I don't want to be radically switching from rtd to gha on
master, and I see your gha's innextare much different. - [ ] CI errors
ConnectionRefusedErrorto the molssi api server?KeyError: "Collection 'Dataset:ds_gradient' not found."
Status
- [x] Code base linted
- [x] Ready to go
Codecov Report
Merging #716 (528ee57) into master (ceff64f) will decrease coverage by
11.08%. The diff coverage is100.00%.
No longer applicable now that docs have been refactored :)