ansible-doctor

Annotation based documentation for your Ansible roles

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.

Pre-commit hook

pip install pre-commit
# Feel .pre-commit-config.yaml as showed below
pre-commit install
pre-commit run --all-files

Sample .pre-commit-config.yaml

-   repo: https://gitlab.com/apollocreed/ansible-doctor
    rev: 1.0.0
    hooks:
      - id: gitlab-ci-linter

To specify your own .ansibledoctor.yml file

-   repo: https://gitlab.com/apollocreed/ansible-doctor
    rev: 1.0.0
    hooks:
      - id: gitlab-ci-linter
        args:
          - -c
          - .ansibledoctor.yml
# You can continue this logic for all argument of CLI

Contributors

Special thanks goes to all contributors.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.