FlexMeasures / flexmeasures / 42822916993
88%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 195
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 87.894%. Remained the same
42822916993

push

github

web-flow 
docs: add a complete plugin automation example (#2705)

* docs: add a complete plugin automation example

Show the test plugin in full as the example of an automation type,
and explain what __data_generator_base__ and __version__ mean for stored automations,
which processes need the plugin enabled,
and how to create and try out an automation with config and parameter files.

Closes #2610

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>

* docs: shorten the plugin automation example

Walk through the example the way the other customisation sections do,
keeping only what the code does not already show,
and point to the automations docs for the add automation command instead of repeating it.

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>

* docs: show the command that creates the example automation

Context:
- The linked automations page uses another type and creates the automation active,
  so the walkthrough could not be followed as written.

Change:
- Show the full command with the example's type and --inactive.
- State that the sensor must belong to the automation's asset or one of its descendants.

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>

* docs: state which version, queues and unknown fields plugin rules cover

Context:
- The example defines __version__ twice, and only the generator class's version is stored with an automation.
- Registration refuses queues outside the known set.
- A nested schema keeps its own handling of unknown fields.

Change:
- Name the generator class's __version__.
- List the allowed queues.
- Limit the unknown fields note to top-level fields.

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>

* docs: resolve the DataGenerator reference in the plugin docs

Context:
- The strict docs build warns that :class:`DataGenerator` has no target.

Change:
- Use the full path, which links to the class's API page.

Signed-off-by: Mohamed Belhsan... (continued)

23291 of 26499 relevant lines covered (87.89%)

0.88 hits per line

Jobs
ID Job ID Ran Files Coverage
1 42822916993.1 195
87.89
GitHub Action Run
Source Files on build 42822916993