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.2.0.tar.gz (28.6 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.2.0-py3-none-any.whl (37.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible_doctor-7.2.0.tar.gz
  • Upload date:
  • Size: 28.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.13.7 Linux/5.15.0-151-generic

File hashes

Hashes for ansible_doctor-7.2.0.tar.gz
Algorithm Hash digest
SHA256 36f4cf0af1e7a59f952e3f532a00f16eabf0b06cd8f6a0c2a1edb971a33a841c
MD5 fadb67dd6cd08e859a1a7340794695c0
BLAKE2b-256 094fcc8c6ec5fd3f9c6eb2d9f2da9246e1569c42df72b32b96f5a1fbbf751d5b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ansible_doctor-7.2.0-py3-none-any.whl
  • Upload date:
  • Size: 37.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.13.7 Linux/5.15.0-151-generic

File hashes

Hashes for ansible_doctor-7.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4d4f59a6f492a4dbe8b82d3cf82fb48bdb6d08b8e47ebef1c1938d081bfcc08c
MD5 c2b6ac8d64297b725c95bb3ffa44cbaf
BLAKE2b-256 fd1a87d9b80279271f08151fe7312ee9031a0c6b40629f582113f080df1a8b2f

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

This release

7.2.0

7.1.0

7.0.9

7.0.8

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