Installed documentation

Archives Ansible Project
1

For everyone who’s about to reply, “docs.ansible.com”, please don’t… I’m asking about docs actually installed and available on the local system, with no Internet connectivity.

ansible-doc has lots of great info for modules. I’m aware of and use it.

But what about documentation for core ansible functionality? If I need help with the syntax of a playbook, exactly how to implement a conditional or loop or variables or whatever… where is that?

No, ‘man ansible’ is not what I’m looking for. Nor is ‘man ansible-playbook’

2

There is no installed copy of the full docs, and there is no downloadable copy of the rendered docs.

You can clone the git repo, or download the source tarball, and build the docs. Or just use the rst files provided there without building with sphinx.

The rst files live in docs/docsite/rst within the source tarball or the git repo.

3

FYI, ansible-doc does more than modules, it now documents other
plugins also, i.e ansible-doc -t lookup nested

4

How’s the day to day user supposed to know this? :confused:

5

Manpage, ansible-doc --help and online docs
(http://docs.ansible.com/ansible/latest/ansible-doc.html) show these
options, it was also added to the changelog.

Unsure of where else we need to put this info, open to suggestions.