search

linode / ansible-specdoc

A utility for dynamically generating Ansible Collection documentation.
Apache License 2.0
2 stars 5 forks source link

[Feature]: show how to import SpecDocMeta and other classes in README #8

Closed t0mk closed 1 year ago

t0mk commented 1 year ago

Description

Hey, I'm just trying to use ansible-specdoc, and it took me a while to figure that I need to

from ansible_specdoc.object import SpecDocData, ...

.. in order to use the project in my ansible module. It would be good if it would be in the examples or mentioned in the readme.

lgarber-akamai commented 1 year ago

I've fleshed out the README a bit more with better examples. Let me know if there are any other details we can add.