ansible-doctor

Annotation based documentation for your Ansible roles

Build Status Docker Hub Quay.io Python Version PyPI Status PyPI Release GitHub contributors Source: GitHub License: GPL-3.0

This project is based on the idea (and at some parts on the code) of 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 or PyPI and as Docker Image on Docker Hub.

The full documentation is available at https://ansible-doctor.geekdocs.de.

Contributors

Special thanks to all contributors. If you would like to contribute, please see the instructions.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (8.4.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for xoxys from gravatar.com xoxys

Credits

Author: Robert Kaussow

License

GNU General Public License v3 (GPLv3) (GPL-3.0-only)

Requires

Python <4.0.0, >=3.10.0

Tags

ansible role documentation

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansible_doctor-7.0.7.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ansible_doctor-7.0.7-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file ansible_doctor-7.0.7.tar.gz.

File metadata

  • Download URL: ansible_doctor-7.0.7.tar.gz
  • Upload date:
  • Size: 27.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.5 Linux/5.15.0-141-generic

File hashes

Hashes for ansible_doctor-7.0.7.tar.gz
Algorithm Hash digest
SHA256 beb44ce657bfe7ca429c12a84c01114636e05352d52cadedb7e15b8ac16c227e
MD5 8dbe2caa2843fc2268d0b75613d2d189
BLAKE2b-256 81aa14f029eb9f1b4b407e926f9172ed597ee66551d97354ea1046ae72e60cbe

See more details on using hashes here.

File details

Details for the file ansible_doctor-7.0.7-py3-none-any.whl.

File metadata

  • Download URL: ansible_doctor-7.0.7-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.13.5 Linux/5.15.0-141-generic

File hashes

Hashes for ansible_doctor-7.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e173fa4e51445fc3709cd2930ddc11a9d8c60d5694e6d1a0d8c38ade5cb2d3c2
MD5 a7b0c8348be290691971ca061a94c241
BLAKE2b-256 2bd3aac276785d7d46beedc17dbc2db84d408a4ab6db681cd4b8dccd271bed60

See more details on using hashes here.

Release history Release notifications | RSS feed

8.4.0

8.3.3

8.3.2

8.3.1

8.3.0

8.2.2

8.2.1

8.2.0

8.1.2

8.1.0

8.0.1

8.0.0

7.3.0

7.2.1

7.2.0

7.1.0

7.0.9

7.0.8

This release

7.0.7

7.0.6

7.0.5

7.0.4

7.0.3

7.0.2

7.0.1

7.0.0

6.0.2

6.0.1

6.0.0

4.1.1

4.1.0

4.0.5

4.0.4

4.0.3

4.0.2

4.0.1

4.0.0

3.1.4

3.1.3

3.1.2

3.1.1

3.1.0

3.0.0

2.1.1

2.1.0

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.10

1.1.9

1.1.8

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.1

1.0.0

0.3.3

0.3.2

0.3.1

0.3.0

0.2.7

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.1.0b2 pre-release

0.1.0b1 pre-release

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page