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 your own templates. This gives you the ability to customize the output and render the data to every format you like (e.g. HTML or XML).

ansible-doctor is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages on GitHub or PyPI and as Docker Image on Docker Hub.

You can find the full documentation at https://ansible-doctor.geekdocs.de.

Contributors

Special thanks goes 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.3)

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 >=3.7.0, <4.0.0

Tags

ansible role documentation

Classifiers

Report project as malware

Metadata

Project links

Key dates

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

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 >=3.7.0, <4.0.0

Tags

ansible role documentation

Classifiers

Report project as malware

Release files for ansible-doctor 1.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansible-doctor 1.1.7
File Size Uploaded
ansible-doctor-1.1.7.tar.gz 26.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ansible-doctor 1.1.7
File Interpreter ABI Platform
ansible_doctor-1.1.7-py3-none-any.whl 41.6 kB Python 3 none any Details

Total release size: 67.7 kB

Release files / ansible-doctor-1.1.7.tar.gz

Download URL ansible-doctor-1.1.7.tar.gz
Size 26.1 kB
Tags Source
SHA-256 checksum
How to use checksums 		144a0c131cb2dfb281704b56e9f27be169786161488ca1235f17dfd1265f3b2e
BLAKE2b-256 checksum
How to use checksums 		5b95eb8587e264e0565682947ed756cc218e1ab26528601bb157e4dfb34e5fc3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via poetry/1.1.12 CPython/3.10.1 Linux/5.4.0-90-generic

Release files / ansible_doctor-1.1.7-py3-none-any.whl

Download URL ansible_doctor-1.1.7-py3-none-any.whl
Size 41.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		2137f4a190610a212e13f654546100e01e2dbbcfe0c3b6ca59d17d8858d5e5bd
BLAKE2b-256 checksum
How to use checksums 		2615e2083587176ea29ceb100af76cdc1037bd5525a724f16f8648b1c5094bdd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via poetry/1.1.12 CPython/3.10.1 Linux/5.4.0-90-generic

Release history Release notifications | RSS feed

8.4.3

2 release files

8.4.2

2 release files

8.4.1

2 release files

8.4.0

2 release files

8.3.3

2 release files

8.3.2

2 release files

8.3.1

2 release files

8.3.0

2 release files

8.2.2

2 release files

8.2.1

2 release files

8.2.0

2 release files

8.1.2

2 release files

8.1.0

2 release files

8.0.1

2 release files

8.0.0

2 release files

7.3.0

2 release files

7.2.1

2 release files

7.2.0

2 release files

7.1.0

2 release files

7.0.9

2 release files

7.0.8

2 release files

7.0.7

2 release files

7.0.6

2 release files

7.0.5

2 release files

7.0.4

2 release files

7.0.3

2 release files

7.0.2

2 release files

7.0.1

2 release files

7.0.0

2 release files

6.0.2

2 release files

6.0.1

2 release files

6.0.0

2 release files

4.1.1

2 release files

4.1.0

2 release files

4.0.5

2 release files

4.0.4

2 release files

4.0.3

2 release files

4.0.2

2 release files

4.0.1

2 release files

4.0.0

2 release files

3.1.4

2 release files

3.1.3

2 release files

3.1.2

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.1.1

1 release file

2.1.0

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.4.8

2 release files

1.4.7

2 release files

1.4.6

2 release files

1.4.5

2 release files

1.4.4

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.4

2 release files

1.3.3

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.10

2 release files

1.1.9

2 release files

1.1.8

2 release files

This release

1.1.7 This release

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Pre-release

0.1.0b2

2 release files

Pre-release

0.1.0b1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page