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.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.8.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.8.0, <4.0.0

Tags

ansible role documentation

Classifiers

Report project as malware

Release files for ansible-doctor 3.1.0

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 3.1.0
File Size Uploaded
ansible_doctor-3.1.0.tar.gz 28.0 kB Details

Built distribution (wheel)

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

Total release size: 73.9 kB

Release files / ansible_doctor-3.1.0.tar.gz

Download URL ansible_doctor-3.1.0.tar.gz
Size 28.0 kB
Tags Source
SHA-256 checksum
How to use checksums 		be8262d30c762aedc9782427c61aafbb50030947a2e23270c3f944196e003552
BLAKE2b-256 checksum
How to use checksums 		5c58a5d439b7bc1f9dacc2e2860c7d09fd7939223a380a27ceb5c5b881498006
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via poetry/1.6.1 CPython/3.12.0 Linux/5.15.0-79-generic

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

Download URL ansible_doctor-3.1.0-py3-none-any.whl
Size 45.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		60d2169a5b1be2c9e7f7a4c995aeedfde39aab59d3a1503c468201eabeb49957
BLAKE2b-256 checksum
How to use checksums 		8560f7eb5a2e03dd00fde8b203277c6e6449e47591dcb0fa0d37beb8bbda5578
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via poetry/1.6.1 CPython/3.12.0 Linux/5.15.0-79-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

This release

3.1.0 This release

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

1.1.7

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