From cf0b2df8e9410a0adda0f81e7d0008537d481b38 Mon Sep 17 00:00:00 2001 From: rallytime Date: Thu, 10 Mar 2016 20:59:40 -0700 Subject: [PATCH] Make configuration docs easier to read --- salt/modules/github.py | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/salt/modules/github.py b/salt/modules/github.py index d4617d749d..bc6c5dbc63 100644 --- a/salt/modules/github.py +++ b/salt/modules/github.py @@ -4,21 +4,25 @@ Module for interacting with the GitHub v3 API. .. versionadded:: 2016.3.0. -:depends: - PyGithub python module -:configuration: Configure this module by specifying the name of a configuration - profile in the minion config, minion pillar, or master config. The module - will use the 'github' key by default, if defined. +:depends: PyGithub python module - For example: +Configuration +------------- - .. code-block:: yaml +Configure this module by specifying the name of a configuration +profile in the minion config, minion pillar, or master config. The module +will use the 'github' key by default, if defined. - github: - token: abc1234 - org_name: my_organization - # optional: only some functions, such as 'add_user', - # require a dev_team_id - dev_team_id: 1234 +For example: + +.. code-block:: yaml + + github: + token: abc1234 + org_name: my_organization + # optional: only some functions, such as 'add_user', + # require a dev_team_id + dev_team_id: 1234 ''' # Import python libs