From fcec3d060029bde078b9b2430496aa64d89b0c48 Mon Sep 17 00:00:00 2001 From: Yanis Guenane Date: Mon, 4 Mar 2019 14:13:52 +0100 Subject: [PATCH] Become plugin: Update documentation to match other plugin doc (#53266) --- docs/docsite/rst/plugins/become.rst | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/docsite/rst/plugins/become.rst b/docs/docsite/rst/plugins/become.rst index f1438a2cb9e..f671d24d157 100644 --- a/docs/docsite/rst/plugins/become.rst +++ b/docs/docsite/rst/plugins/become.rst @@ -1,9 +1,13 @@ -.. contents:: Topics - -.. versionadded:: 2.8 +.. _become_plugins: Become Plugins --------------- +============== + +.. contents:: + :local: + :depth: 2 + +.. versionadded:: 2.8 Become plugins work to ensure that Ansible can use certain privilege escalation systems when running the basic commands to work with the target machine as well as the modules required to execute the tasks specified in @@ -16,7 +20,7 @@ with the permissions of that user. .. _enabling_become: Enabling Become Plugins -+++++++++++++++++++++++ +----------------------- The become plugins shipped with Ansible are already enabled. Custom plugins can be added by placing them into a ``become_plugins`` directory adjacent to your play, inside a role, or by placing them in one of @@ -26,7 +30,7 @@ the become plugin directory sources configured in :ref:`ansible.cfg `` to see specific documentation and examples. + .. toctree:: :maxdepth: 1 :glob: