{"id":13580511,"url":"https://github.com/outbit/ansible-docgen","last_synced_at":"2026-03-16T13:11:21.757Z","repository":{"id":35599872,"uuid":"39872958","full_name":"outbit/ansible-docgen","owner":"outbit","description":"Generate documentation from annotated Ansible Playbooks and Roles","archived":false,"fork":false,"pushed_at":"2024-04-10T00:43:18.000Z","size":164,"stargazers_count":75,"open_issues_count":2,"forks_count":14,"subscribers_count":7,"default_branch":"develop","last_synced_at":"2025-03-08T23:45:13.196Z","etag":null,"topics":["annotated-ansible-playbooks","annotation","ansible","documentation","playbook"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/ansible-docgen/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outbit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-07-29T04:19:31.000Z","updated_at":"2024-12-30T22:22:15.000Z","dependencies_parsed_at":"2024-04-10T00:38:34.332Z","dependency_job_id":"f9839252-7aef-48f2-b567-561d1de5e3e2","html_url":"https://github.com/outbit/ansible-docgen","commit_stats":null,"previous_names":["starboarder2001/ansible-docgen","thedavidwhiteside/ansible-docgen"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outbit%2Fansible-docgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outbit%2Fansible-docgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outbit%2Fansible-docgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outbit%2Fansible-docgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outbit","download_url":"https://codeload.github.com/outbit/ansible-docgen/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243826788,"owners_count":20354220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotated-ansible-playbooks","annotation","ansible","documentation","playbook"],"created_at":"2024-08-01T15:01:52.554Z","updated_at":"2026-03-16T13:11:21.714Z","avatar_url":"https://github.com/outbit.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"ansible-docgen\n=====================\n\nDescription\n===========\n\nansible-docgen generates documentation from annotated Ansible Playbooks and Roles.\n\n[![Build Status](https://app.travis-ci.com/outbit/ansible-docgen.svg?branch=develop \"ansible-docs latest build\")](http://travis-ci.org/outbit/ansible-docgen)\n[![PIP Version](https://img.shields.io/pypi/v/ansible-docgen.svg \"ansible-docs PyPI version\")](https://pypi.python.org/pypi/ansible-docgen)\n[![Coverage Status](https://coveralls.io/repos/outbit/ansible-docgen/badge.svg?branch=develop\u0026service=github)](https://coveralls.io/github/outbit/ansible-docgen?branch=develop)\n[![Gitter IM](https://badges.gitter.im/Join%20Chat.svg)](https://matrix.to/#/#ansible-docgen:gitter.im)\n\n\nInstallation\n===========\n\n```shell\npip install ansible-docgen\n```\n\nor\n\n```shell\neasy_install ansible-docgen\n```\n\nUsage\n===========\n\n### Annotate Your Playbooks and Roles\n```yaml\n---\n# test_playbook.yml\n# Author: John Doe\n# Description: Install a Webserver\n- name: Install Apache\n  yum: name=httpd state=installed\n```\n```yaml\n---\n# roles/appserver/tasks/main.yml\n# Author: John Doe\n# Description: Appserver role\n- name: Copy Installer\n  copy: src=installer dest=/tmp/\n  tags:\n    - copy-installer\n- name:  Run Installer\n  shell: /tmp/installer.sh\n  tags:\n    - run-installer\n```\n### Generate Documentation from Annotation\n##### Use -p to specify your project directory. Click the links to preview the Markup generated by ansible-docgen. Warning: This will overwrite existing README files.\n\n`ansible-docgen -p your_ansible_project`\n\n`Generated Markup File` [your_ansible_project/rolestest/README.md](test/integration/project1/rolestest/README.md)\n\n`Generated Markup File` [your_ansible_project/roles/README.md](test/integration/project1/roles/README.md)\n\n`Generated Markup File` [your_ansible_project/README.md](test/integration/project1/README.md)\n\n\n##### If your current directory is your project directory just run ansible-docgen without any arguments. Warning: This will overwrite existing README files.\n\n`cd your_ansible_project \u0026\u0026 ansible-docgen`\n\n`Generated Markup File` [otherroles/README.md](test/integration/project1/otherroles/README.md)\n\n`Generated Markup File` [roles/README.md](test/integration/project1/roles/README.md)\n\n`Generated Markup File` [README.md](test/integration/project1/README.md)\n\n##### Help output\n```bash\nusage: ansible-docgen [-h] [-p PROJECT] [-f FILENAME] [-s STYLE] [-n] [-v]\n\noptions:\n  -h, --help            show this help message and exit\n  -p PROJECT, --project PROJECT\n                        Path to Ansible project. Default is the current directory.\n  -f FILENAME, --filename FILENAME\n                        filename used for the output documentation file. Default is README\n  -s STYLE, --style STYLE\n                        Choose the format for the documentation. Default is markdown. Example: --style=[markdown]\n  -n, --no-tags         This option disables show tags in the documentation\n  -v, --version         Print version\n  ```\n\nLicense\n=======\n\nansible-docgen is released under the [MIT License](LICENSE.md).\n\nAuthor\n======\n\nDavid Whiteside (\u003cdavid@davidwhiteside.com\u003e)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutbit%2Fansible-docgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutbit%2Fansible-docgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutbit%2Fansible-docgen/lists"}