# ansible-doctor
Annotation based documentation for your Ansible roles
[](https://ci.thegeeklab.de/repos/thegeeklab/ansible-doctor)
[](https://hub.docker.com/r/thegeeklab/ansible-doctor)
[](https://quay.io/repository/thegeeklab/ansible-doctor)
[](https://pypi.org/project/ansible-doctor/)
[](https://pypi.org/project/ansible-doctor/)
[](https://pypi.org/project/ansible-doctor/)
[](https://github.com/thegeeklab/ansible-doctor/graphs/contributors)
[](https://github.com/thegeeklab/ansible-doctor)
[](https://github.com/thegeeklab/ansible-doctor/blob/main/LICENSE)
This project is based on the idea (and at some parts on the code) of [ansible-autodoc](https://github.com/AndresBott/ansible-autodoc) by Andres Bott so credits goes to him for his work.
_ansible-doctor_ is a simple annotation like documentation generator based on Jinja2 templates. While _ansible-doctor_ comes with a default template called `readme`, it is also possible to write custom templates to customize the output or render the data to other formats like HTML or XML as well.
_ansible-doctor_ is designed to work within a CI pipeline to complete the existing testing and deployment workflow. Releases are available as Python Packages on [GitHub](https://github.com/thegeeklab/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image on [Docker Hub](https://hub.docker.com/r/thegeeklab/ansible-doctor).
The full documentation is available at [https://ansible-doctor.geekdocs.de](https://ansible-doctor.geekdocs.de/).
## Contributors
Special thanks to all [contributors](https://github.com/thegeeklab/ansible-doctor/graphs/contributors). If you would like to contribute,
please see the [instructions](https://github.com/thegeeklab/ansible-doctor/blob/main/CONTRIBUTING.md).
## License
This project is licensed under the GPL-3.0 License - see the [LICENSE](https://github.com/thegeeklab/ansible-doctor/blob/main/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://ansible-doctor.geekdocs.de/",
"name": "ansible-doctor",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.0",
"maintainer_email": null,
"keywords": "ansible, role, documentation",
"author": "Robert Kaussow",
"author_email": "mail@thegeeklab.de",
"download_url": "https://files.pythonhosted.org/packages/7a/7a/e688ca2bed58fefbb2c14b65c88f4436e7917c82f6ecab28a8d45dde1579/ansible_doctor-4.0.4.tar.gz",
"platform": null,
"description": "# ansible-doctor\n\nAnnotation based documentation for your Ansible roles\n\n[](https://ci.thegeeklab.de/repos/thegeeklab/ansible-doctor)\n[](https://hub.docker.com/r/thegeeklab/ansible-doctor)\n[](https://quay.io/repository/thegeeklab/ansible-doctor)\n[](https://pypi.org/project/ansible-doctor/)\n[](https://pypi.org/project/ansible-doctor/)\n[](https://pypi.org/project/ansible-doctor/)\n[](https://github.com/thegeeklab/ansible-doctor/graphs/contributors)\n[](https://github.com/thegeeklab/ansible-doctor)\n[](https://github.com/thegeeklab/ansible-doctor/blob/main/LICENSE)\n\nThis project is based on the idea (and at some parts on the code) of [ansible-autodoc](https://github.com/AndresBott/ansible-autodoc) by Andres Bott so credits goes to him for his work.\n\n_ansible-doctor_ is a simple annotation like documentation generator based on Jinja2 templates. While _ansible-doctor_ comes with a default template called `readme`, it is also possible to write custom templates to customize the output or render the data to other formats like HTML or XML as well.\n\n_ansible-doctor_ is designed to work within a CI pipeline to complete the existing testing and deployment workflow. Releases are available as Python Packages on [GitHub](https://github.com/thegeeklab/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image on [Docker Hub](https://hub.docker.com/r/thegeeklab/ansible-doctor).\n\nThe full documentation is available at [https://ansible-doctor.geekdocs.de](https://ansible-doctor.geekdocs.de/).\n\n## Contributors\n\nSpecial thanks to all [contributors](https://github.com/thegeeklab/ansible-doctor/graphs/contributors). If you would like to contribute,\nplease see the [instructions](https://github.com/thegeeklab/ansible-doctor/blob/main/CONTRIBUTING.md).\n\n## License\n\nThis project is licensed under the GPL-3.0 License - see the [LICENSE](https://github.com/thegeeklab/ansible-doctor/blob/main/LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Generate documentation from annotated Ansible roles using templates.",
"version": "4.0.4",
"project_urls": {
"Documentation": "https://ansible-doctor.geekdocs.de/",
"Homepage": "https://ansible-doctor.geekdocs.de/",
"Repository": "https://github.com/thegeeklab/ansible-doctor/"
},
"split_keywords": [
"ansible",
" role",
" documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7ee7de0872990b4efe0dda6d3d66962af8b4f8560a2d9a0d1dec0cc1d671a5f6",
"md5": "c1f4bc4ab7a300fff4676a48c758bfa1",
"sha256": "861f4970d645da4f33e49f1e3bc881fea7a384be30629ab6b5e69068a5b3ca42"
},
"downloads": -1,
"filename": "ansible_doctor-4.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c1f4bc4ab7a300fff4676a48c758bfa1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.0",
"size": 46534,
"upload_time": "2024-04-14T09:48:15",
"upload_time_iso_8601": "2024-04-14T09:48:15.165936Z",
"url": "https://files.pythonhosted.org/packages/7e/e7/de0872990b4efe0dda6d3d66962af8b4f8560a2d9a0d1dec0cc1d671a5f6/ansible_doctor-4.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a7ae688ca2bed58fefbb2c14b65c88f4436e7917c82f6ecab28a8d45dde1579",
"md5": "cf30b1255e2ab9b41d26b49d345718e1",
"sha256": "9612467a6b3dc0ac129690f442c5ba1f660e6790fde40c7eaa29c658e41bbc95"
},
"downloads": -1,
"filename": "ansible_doctor-4.0.4.tar.gz",
"has_sig": false,
"md5_digest": "cf30b1255e2ab9b41d26b49d345718e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.9.0",
"size": 28312,
"upload_time": "2024-04-14T09:48:17",
"upload_time_iso_8601": "2024-04-14T09:48:17.205259Z",
"url": "https://files.pythonhosted.org/packages/7a/7a/e688ca2bed58fefbb2c14b65c88f4436e7917c82f6ecab28a8d45dde1579/ansible_doctor-4.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-14 09:48:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thegeeklab",
"github_project": "ansible-doctor",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ansible-doctor"
}
JSON
