├── .circleci └── config.yml ├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.md ├── doc ├── backlog.md ├── changelog.md ├── development.md └── templates.md ├── install.py ├── requirements.txt ├── setup.py ├── src ├── ansibleautodoc │ ├── Annotation.py │ ├── AutodocCli.py │ ├── Config.py │ ├── Contstants.py │ ├── DocumentationGenerator.py │ ├── DocumentationParser.py │ ├── FileRegistry.py │ ├── Utils.py │ ├── __init__.py │ └── templates │ │ ├── cliprint │ │ ├── _action.j2 │ │ ├── _description.j2 │ │ ├── _tags.j2 │ │ ├── _todo.j2 │ │ ├── _var.j2 │ │ └── print_to_cli.j2 │ │ ├── doc_and_readme │ │ ├── README.md.j2 │ │ ├── _example.j2 │ │ └── doc │ │ │ ├── _action.j2 │ │ │ ├── _tags.j2 │ │ │ ├── report.md.j2 │ │ │ ├── tags.md.j2 │ │ │ ├── todo.md.j2 │ │ │ └── variables.md.j2 │ │ └── readme │ │ ├── README.md.j2 │ │ ├── _action.j2 │ │ ├── _dev_var_dump.txt.j2 │ │ ├── _example.j2 │ │ ├── _tags.j2 │ │ ├── _todo.j2 │ │ └── _vars.j2 └── bin │ └── ansible-autodoc └── test ├── ansibleautodoc ├── test_Annotation.py ├── test_Config.py ├── test_DocumentationParser.py ├── test_FileRegistry.py ├── test_Generator.py └── test_utils.py ├── sample-project ├── _after_description.md ├── ansible-playbook.yaml ├── autodoc.conf.yaml ├── host_vars │ └── host.yaml ├── meta.yaml ├── playbook-2.yml └── roles │ ├── role1 │ ├── defaults │ │ └── main.yaml │ ├── doc_template │ │ └── role_tags.md.j2 │ ├── handlers │ │ └── main.yaml │ └── tasks │ │ └── main.yaml │ └── role2 │ ├── defaults │ └── main.yaml │ ├── handlers │ └── main.yaml │ └── tasks │ ├── included-task.yaml │ └── main.yaml ├── test-project ├── roles │ └── role1 │ │ └── tasks │ │ └── test.yaml └── test.yaml └── test-template ├── Readme.md.j2 └── sub_dir ├── _sample_include.md.j2 └── subdir.md.j2 /.circleci/config.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/.circleci/config.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/.gitignore -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/LICENSE -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/MANIFEST.in -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/README.md -------------------------------------------------------------------------------- /doc/backlog.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/doc/backlog.md -------------------------------------------------------------------------------- /doc/changelog.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/doc/changelog.md -------------------------------------------------------------------------------- /doc/development.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/doc/development.md -------------------------------------------------------------------------------- /doc/templates.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/doc/templates.md -------------------------------------------------------------------------------- /install.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/install.py -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | jinja2 2 | pyyaml -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/setup.py -------------------------------------------------------------------------------- /src/ansibleautodoc/Annotation.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/Annotation.py -------------------------------------------------------------------------------- /src/ansibleautodoc/AutodocCli.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/AutodocCli.py -------------------------------------------------------------------------------- /src/ansibleautodoc/Config.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/Config.py -------------------------------------------------------------------------------- /src/ansibleautodoc/Contstants.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/Contstants.py -------------------------------------------------------------------------------- /src/ansibleautodoc/DocumentationGenerator.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/DocumentationGenerator.py -------------------------------------------------------------------------------- /src/ansibleautodoc/DocumentationParser.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/DocumentationParser.py -------------------------------------------------------------------------------- /src/ansibleautodoc/FileRegistry.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/FileRegistry.py -------------------------------------------------------------------------------- /src/ansibleautodoc/Utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/Utils.py -------------------------------------------------------------------------------- /src/ansibleautodoc/__init__.py: -------------------------------------------------------------------------------- 1 | name = "ansibleautodoc" 2 | __version__ = '0.5.3' -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/cliprint/_action.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/cliprint/_action.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/cliprint/_description.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/cliprint/_description.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/cliprint/_tags.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/cliprint/_tags.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/cliprint/_todo.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/cliprint/_todo.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/cliprint/_var.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/cliprint/_var.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/cliprint/print_to_cli.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/cliprint/print_to_cli.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/doc_and_readme/README.md.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/doc_and_readme/README.md.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/doc_and_readme/_example.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/doc_and_readme/_example.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/doc_and_readme/doc/_action.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/doc_and_readme/doc/_action.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/doc_and_readme/doc/_tags.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/doc_and_readme/doc/_tags.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/doc_and_readme/doc/report.md.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/doc_and_readme/doc/report.md.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/doc_and_readme/doc/tags.md.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/doc_and_readme/doc/tags.md.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/doc_and_readme/doc/todo.md.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/doc_and_readme/doc/todo.md.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/doc_and_readme/doc/variables.md.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/doc_and_readme/doc/variables.md.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/readme/README.md.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/readme/README.md.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/readme/_action.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/readme/_action.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/readme/_dev_var_dump.txt.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/readme/_dev_var_dump.txt.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/readme/_example.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/readme/_example.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/readme/_tags.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/readme/_tags.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/readme/_todo.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/readme/_todo.j2 -------------------------------------------------------------------------------- /src/ansibleautodoc/templates/readme/_vars.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/ansibleautodoc/templates/readme/_vars.j2 -------------------------------------------------------------------------------- /src/bin/ansible-autodoc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/src/bin/ansible-autodoc -------------------------------------------------------------------------------- /test/ansibleautodoc/test_Annotation.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/ansibleautodoc/test_Annotation.py -------------------------------------------------------------------------------- /test/ansibleautodoc/test_Config.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/ansibleautodoc/test_Config.py -------------------------------------------------------------------------------- /test/ansibleautodoc/test_DocumentationParser.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/ansibleautodoc/test_DocumentationParser.py -------------------------------------------------------------------------------- /test/ansibleautodoc/test_FileRegistry.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/ansibleautodoc/test_FileRegistry.py -------------------------------------------------------------------------------- /test/ansibleautodoc/test_Generator.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/ansibleautodoc/test_Generator.py -------------------------------------------------------------------------------- /test/ansibleautodoc/test_utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/ansibleautodoc/test_utils.py -------------------------------------------------------------------------------- /test/sample-project/_after_description.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/_after_description.md -------------------------------------------------------------------------------- /test/sample-project/ansible-playbook.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/ansible-playbook.yaml -------------------------------------------------------------------------------- /test/sample-project/autodoc.conf.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/autodoc.conf.yaml -------------------------------------------------------------------------------- /test/sample-project/host_vars/host.yaml: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /test/sample-project/meta.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/meta.yaml -------------------------------------------------------------------------------- /test/sample-project/playbook-2.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/playbook-2.yml -------------------------------------------------------------------------------- /test/sample-project/roles/role1/defaults/main.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/roles/role1/defaults/main.yaml -------------------------------------------------------------------------------- /test/sample-project/roles/role1/doc_template/role_tags.md.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/roles/role1/doc_template/role_tags.md.j2 -------------------------------------------------------------------------------- /test/sample-project/roles/role1/handlers/main.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | -------------------------------------------------------------------------------- /test/sample-project/roles/role1/tasks/main.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/roles/role1/tasks/main.yaml -------------------------------------------------------------------------------- /test/sample-project/roles/role2/defaults/main.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/roles/role2/defaults/main.yaml -------------------------------------------------------------------------------- /test/sample-project/roles/role2/handlers/main.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/roles/role2/handlers/main.yaml -------------------------------------------------------------------------------- /test/sample-project/roles/role2/tasks/included-task.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/roles/role2/tasks/included-task.yaml -------------------------------------------------------------------------------- /test/sample-project/roles/role2/tasks/main.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/sample-project/roles/role2/tasks/main.yaml -------------------------------------------------------------------------------- /test/test-project/roles/role1/tasks/test.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/test-project/roles/role1/tasks/test.yaml -------------------------------------------------------------------------------- /test/test-project/test.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/test-project/test.yaml -------------------------------------------------------------------------------- /test/test-template/Readme.md.j2: -------------------------------------------------------------------------------- 1 | {# This is only used in tests #} 2 | Sample verification string -------------------------------------------------------------------------------- /test/test-template/sub_dir/_sample_include.md.j2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/andresbott/ansible-autodoc/HEAD/test/test-template/sub_dir/_sample_include.md.j2 -------------------------------------------------------------------------------- /test/test-template/sub_dir/subdir.md.j2: -------------------------------------------------------------------------------- 1 | --------------------------------------------------------------------------------