Installed documentation

16 views
Skip to first unread message

John Oliver

unread,
Feb 16, 2018, 4:43:21 PM2/16/18
to Ansible Project
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'

Matt Martz

unread,
Feb 16, 2018, 4:52:00 PM2/16/18
to ansible...@googlegroups.com
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.

--
You received this message because you are subscribed to the Google Groups "Ansible Project" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ansible-project+unsubscribe@googlegroups.com.
To post to this group, send email to ansible-project@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/ansible-project/d71db734-f54d-4a57-b646-18127fa06491%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.



--
Matt Martz
@sivel
sivel.net

Brian Coca

unread,
Feb 16, 2018, 5:21:09 PM2/16/18
to Ansible Project
FYI, ansible-doc does more than modules, it now documents other
plugins also, i.e ansible-doc -t lookup nested


--
----------
Brian Coca

Varun Chopra

unread,
Feb 19, 2018, 2:58:45 AM2/19/18
to Ansible Project
How's the day to day user supposed to know this? :/

Brian Coca

unread,
Feb 19, 2018, 1:28:54 PM2/19/18
to Ansible Project
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.


--
----------
Brian Coca
Reply all
Reply to author
Forward
0 new messages