Skip to content

Ansible documentation for GNU Emacs

License

Notifications You must be signed in to change notification settings

emacsorphanage/ansible-doc

Repository files navigation

ansible-doc

Maintenance License GPL 3 MELPA Stable MELPA

Ansible documentation lookup for GNU Emacs:

Ansible documentation in GNU Emacs

Installation

As usual, from MELPA or MELPA Stable, with M-x package-install RET ansible-doc.

In your Cask file:

(source melpa)

(depends-on "ansible-doc")

In your init.el:

(add-hook 'yaml-mode-hook #'ansible-doc-mode)

Usage

In a YAML Mode buffer, press C-c ? (ansible-doc) to view the documentation of an Ansible Module. The command prompts for the name of a module, defaulting to the module at point if any.

The first invocation of ansible-doc may take some time, because the command assembles a list of all Ansible modules for completion.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

See COPYING for details.