From 5b7f7f9e099265f8261888adab4f78b99b9be088 Mon Sep 17 00:00:00 2001 From: Ingmar Splitt Date: Mon, 19 Feb 2024 22:13:16 +0100 Subject: [PATCH] Update api.md --- docs/user/api.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/user/api.md b/docs/user/api.md index 608167b8..fd1bf1b4 100644 --- a/docs/user/api.md +++ b/docs/user/api.md @@ -9,9 +9,10 @@ Use the `shepherd-herd` command line utility to orchestrate a group of shepherd The recorder is used to configure all relevant hardware and software and to sample and extract data from the analog frontend. -```{autoclass} shepherd_sheep.ShepherdHarvester -:members: -:inherited-members: +```{eval-rst} +.. autoclass:: shepherd_sheep.ShepherdHarvester + :members: + :inherited-members: ``` Usage with a high-level example: @@ -35,9 +36,10 @@ The example is taken from [sheep/init](https://github.com/orgua/shepherd/blob/ma The emulator is used to emulate previously recorded IV data to an attached sensor node. -```{autoclass} shepherd_sheep.ShepherdEmulator -:members: -:inherited-members: +```{eval-rst} +.. autoclass:: shepherd_sheep.ShepherdEmulator + :members: + :inherited-members: ``` Usage with a high-level example, task: