teemtee / tmt

Test Management Tool
MIT License
76 stars 112 forks source link

Include plugin class docstring in the online docs #2871

Open psss opened 4 weeks ago

psss commented 4 weeks ago

Let's allow providing an introduction text for each step plugin class so that general information can be included in the online documentation.

Plus, specifically for the provision step, let's make the hardware specification more discoverable. Also include a simple example at the very beginning of the hardware.

Pull Request Checklist

psss commented 4 weeks ago

@bgoncalv, this should hopefully improve a little it your use case of searching for the hardware spec from provision plugin docs. Or do you think the link to the hardware should be rather provided in each and every plugin doc?

bgoncalv commented 4 weeks ago

@bgoncalv, this should hopefully improve a little it your use case of searching for the hardware spec from provision plugin docs. Or do you think the link to the hardware should be rather provided in each and every plugin doc?

I this should help as the provision section will mention the hardware section.

Btw, thanks for looking at this 😄