ansible-doc-generator
ansible-doc-generator copied to clipboard
CLI for documenting Ansible roles into Markdown files.
``` ❯ ansible-doc-generator -p roles.yml /usr/local/lib/ruby/gems/3.0.0/gems/ansible_doc_generator-0.1.0/lib/ansible_doc_generator/doc_generator.rb:59:in `join': no implicit conversion of nil into String (TypeError) from /usr/local/lib/ruby/gems/3.0.0/gems/ansible_doc_generator-0.1.0/lib/ansible_doc_generator/doc_generator.rb:59:in `tasks_yml_path_for_role' from /usr/local/lib/ruby/gems/3.0.0/gems/ansible_doc_generator-0.1.0/lib/ansible_doc_generator/doc_generator.rb:26:in `block in parse_roles' from /usr/local/lib/ruby/gems/3.0.0/gems/ansible_doc_generator-0.1.0/lib/ansible_doc_generator/doc_generator.rb:25:in `each' from /usr/local/lib/ruby/gems/3.0.0/gems/ansible_doc_generator-0.1.0/lib/ansible_doc_generator/doc_generator.rb:25:in `parse_roles' from...
When using a variable not defined capture the exception and show a friendly error message informing: - the variable is not avaialble in the role - which variable is causing...
I think it shouldn't be too complicated to support task import and generate the documentation as if the content of the file is present, i.e: ``` - import_tasks: ubuntu_16.yml when:...
My initial execution on ubuntu did not work, giving a reference to `pry`. Once I installed `pry`, the application worked.
the roles are not being read from the correct path `main.yml not found in path /software/test/install_this/tasks/main.yml` but they exist correctly in `/software/test/roles/install_this/tasks/main.yml` quick fix was on line 28 of lib/ansible\_doc\_generator/doc\_generator.rb ...