search

bluesky / ophyd-async

Hardware abstraction for bluesky written using asyncio
https://blueskyproject.io/ophyd-async
BSD 3-Clause "New" or "Revised" License
11 stars 25 forks source link

fix pydantic models in API #443

Open evalott100 opened 4 months ago

evalott100 commented 4 months ago

In https://github.com/bluesky/ophyd-async/pull/430

We include autodoc-pydantic in order for the pydantic models to be included in the API. autodoc-pydantic seems to allow for warningless generation of docs, but doesn't generate entries for the models in the API.

stan-dot commented 2 hours ago

which API is this for? the set of library exports? the CLI?

do we need another dependency? arguably judging by name autodoc-pydantic will only generate docs not API.

also models of what exactly?

evalott100 commented 2 hours ago

which API is this for? the set of library exports? the CLI? do we need another dependency? arguably judging by name autodoc-pydantic will only generate docs

The API in the docs: https://blueskyproject.io/ophyd-async/main/_api/ophyd_async.html

also models of what exactly?

All the pydantic models used in the docs.

I should be able to click and go to the type of SeqTableInfo here: https://blueskyproject.io/ophyd-async/main/_api/ophyd_async.plan_stubs.html#ophyd_async.plan_stubs.fly_and_collect