andresbott / ansible-autodoc Goto Github PK

there are no activity for at least year. Should i use it because i really want to?

The 0.5.3 release is missing a release and tag on Github:

https://github.com/AndresBott/ansible-autodoc/releases

Hi @andresbott,

thanks for this awesome tool! I was looking for something like PHPDoc to generate my README.md and came along to this project. I'm impressed!

I've seen that there is a cosmetic issue in @meta author and @meta email:

# @meta author: Kevin James
# @meta email: [email protected]

will result in

This role:  was created by: Kevin james <LINEBREAK>
[email protected]

So the last name of the author is fully in lowercase, while the email address is capitalized. Addtionally it would be great to have author and email in a single line and the email in angle brackets ('<>').

Thanks!

Hi,

there is a deprecation warning

Annotation.py:275: YAMLLoadWarning: calling yaml.load() without Loader=... is deprecated, as the default Loader is unsafe. Please read https://msg.pyyaml.org/load for full details.
  data = yaml.load(yaml_file)

running Python 3.7.3 on Fedora.

how about the possibility to get a list of available playbooks
for example:

roles/auth
├── files
│   ├── skel
│   └── sudoers
├── handlers
│   └── main.yml
├── tasks
│   ├── auth.yml
│   ├── environment-redhat.yml
│   └── main.yml
├── templates
│   └── sshd_config.j2
└── vars
   └── redhat.yml

as you can see in my task i have a main.yml which includes the others. would be nice if i could get a list of the yml-files in the roles/$ROLE/task directory besides the tasks within the yml-files