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.1)

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

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-1.4.4.tar.gz (27.1 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-1.4.4-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

Details for the file ansible-doctor-1.4.4.tar.gz.

File metadata

  • Download URL: ansible-doctor-1.4.4.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.6 Linux/5.4.0-125-generic

File hashes

Hashes for ansible-doctor-1.4.4.tar.gz
Algorithm Hash digest
SHA256 aea1099f901ea5ad83309ab6227c9008b4be2008e1bc72c2c5fbf2fef21bb11b
MD5 7a5817c8dea9828b421318bf90e98191
BLAKE2b-256 05ef7020332be7a644ed746897f2edac69472440e33392ab7f56bc374dcc7cf4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ansible_doctor-1.4.4-py3-none-any.whl
  • Upload date:
  • Size: 43.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.6 Linux/5.4.0-125-generic

File hashes

Hashes for ansible_doctor-1.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 780428e007a8b9dd4b1d1bf91f527a7fb10561ed2e1895fa187f90d5316c046b
MD5 af885f6004f68cb2b3cdb09f759e978b
BLAKE2b-256 7b6b410aee7d3b0302bcb605a045b74ec09b2bbc0385aab91183f0ea5bd0b93c

See more details on using hashes here.

Release history Release notifications | RSS feed

8.4.1

2 files

8.4.0

2 files

8.3.3

2 files

8.3.2

2 files

8.3.1

2 files

8.3.0

2 files

8.2.2

2 files

8.2.1

2 files

8.2.0

2 files

8.1.2

2 files

8.1.0

2 files

8.0.1

2 files

8.0.0

2 files

7.3.0

2 files

7.2.1

2 files

7.2.0

2 files

7.1.0

2 files

7.0.9

2 files

7.0.8

2 files

7.0.7

2 files

7.0.6

2 files

7.0.5

2 files

7.0.4

2 files

7.0.3

2 files

7.0.2

2 files

7.0.1

2 files

7.0.0

2 files

6.0.2

2 files

6.0.1

2 files

6.0.0

2 files

4.1.1

2 files

4.1.0

2 files

4.0.5

2 files

4.0.4

2 files

4.0.3

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

3.1.4

2 files

3.1.3

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.1.1

1 file

2.1.0

2 files

2.0.5

2 files

2.0.4

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

This release

1.4.4 This release

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.10

2 files

1.1.9

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Pre-release

0.1.0b2

2 files

Pre-release

0.1.0b1

2 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