search

PyFixate / Fixate

Framework for hardware test fixtures and automatic test environments
MIT License
22 stars 16 forks source link

Improve api docs #207

Closed clint-lawrence closed 1 month ago

clint-lawrence commented 1 month ago

Remove internals, add fixate._switching + a few other tweaks

clint-lawrence commented 1 month ago

@josh-marshall-amp @jcollins1983 My primary aim was to get the new jig switching api documented before creating a new release. I hope to do that as soon as this is merged.

I haven't been too pedantic, but quickly removed as much of the obviously non-public api details that were in the initial documentation build. I think overall it should make the docs much more usable

josh-marshall-amp commented 1 month ago

for @jcollins1983 reference, the PRs get their auto-gen docs chucked up on readthedocs too. In this case it's the below, and you can always sub in the relevant PR

https://fixate--207.org.readthedocs.build