Skip to content

Commit

Permalink
Update api.md
Browse files Browse the repository at this point in the history
  • Loading branch information
orgua committed Feb 19, 2024
1 parent 0498dfe commit 5b7f7f9
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/user/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down

0 comments on commit 5b7f7f9

Please sign in to comment.