Generate documentation from annotated Ansible roles using templates.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for xoxys from gravatar.com xoxys

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 (GPLv3) (GPL-3.0-only)
  • Author: Robert Kaussow
  • Tags ansible , role , documentation
  • Requires: Python <4.0.0, >=3.9.0
Classifiers
Report project as malware

Project description

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 details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for xoxys from gravatar.com xoxys

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v3 (GPLv3) (GPL-3.0-only)
  • Author: Robert Kaussow
  • Tags ansible , role , documentation
  • Requires: Python <4.0.0, >=3.9.0
Classifiers

Release history Release notifications | RSS feed

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

This version

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

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-6.0.0.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

ansible_doctor-6.0.0-py3-none-any.whl (47.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansible_doctor-6.0.0.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/5.15.0-107-generic

File hashes

Hashes for ansible_doctor-6.0.0.tar.gz
Algorithm Hash digest
SHA256 0ece90080e87e6f8372c4d570ffff20add413cd1c6a458bfe12e9faf65ff2a56
MD5 eac351c9b9b1f1730c2647c093c86cc0
BLAKE2b-256 1fa3d18477ad3deff15b057d7e183ca8bb82915daf75bb00425d9c01fa1ce001

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ansible_doctor-6.0.0-py3-none-any.whl
  • Upload date:
  • Size: 47.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/5.15.0-107-generic

File hashes

Hashes for ansible_doctor-6.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 851cbf9a7d4313796d1258fb417789f16c286884e671286602ebfe23cc43abfd
MD5 3ac3417773b548c1f86b5d86f4ffb0b3
BLAKE2b-256 22eea2962b81132d6d767de6cc0957e65f8fadc97583824301bf6cff1941d6b6

See more details on using hashes here.

Supported by

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