diff --git a/.copier-answers.yml b/.copier-answers.yml index 3a8f0796..cb439831 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -9,6 +9,7 @@ license: apache loaders: - module - state + - utils max_salt_version: 3006 no_saltext_namespace: false package_name: github diff --git a/docs/index.rst b/docs/index.rst index b6e97b4d..a4e6f171 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,6 +17,7 @@ Salt Extension for interacting with Github ref/modules/index ref/states/index + ref/utils/index .. toctree:: :maxdepth: 2 diff --git a/docs/ref/modules/all.rst b/docs/ref/modules/all.rst deleted file mode 100644 index 00018dc7..00000000 --- a/docs/ref/modules/all.rst +++ /dev/null @@ -1,12 +0,0 @@ - -.. all-saltext.github.modules: - -_________________ -Execution Modules -_________________ - -.. autosummary:: - :toctree: - - saltext.github.modules.github - saltext.github.modules.github_mod diff --git a/docs/ref/modules/all/salt.modules.github.rst b/docs/ref/modules/all/salt.modules.github.rst deleted file mode 100644 index 04d44068..00000000 --- a/docs/ref/modules/all/salt.modules.github.rst +++ /dev/null @@ -1,5 +0,0 @@ -salt.modules.github -=================== - -.. automodule:: salt.modules.github - :members: diff --git a/docs/ref/modules/saltext.github.modules.github_mod.rst b/docs/ref/modules/saltext.github.modules.github_mod.rst deleted file mode 100644 index 22065d6b..00000000 --- a/docs/ref/modules/saltext.github.modules.github_mod.rst +++ /dev/null @@ -1,5 +0,0 @@ -``github`` -========== - -.. automodule:: saltext.github.modules.github_mod - :members: diff --git a/docs/ref/modules/saltext.github.modules.rst b/docs/ref/modules/saltext.github.modules.rst deleted file mode 100644 index e3de334b..00000000 --- a/docs/ref/modules/saltext.github.modules.rst +++ /dev/null @@ -1,6 +0,0 @@ - -saltext.github.modules.github_mod -================================= - -.. automodule:: saltext.github.modules.github_mod - :members: diff --git a/docs/ref/states/all.rst b/docs/ref/states/all.rst deleted file mode 100644 index 7a8144c5..00000000 --- a/docs/ref/states/all.rst +++ /dev/null @@ -1,12 +0,0 @@ - -.. all-saltext.github.states: - -_____________ -State Modules -_____________ - -.. autosummary:: - :toctree: - - saltext.github.states.github - saltext.github.states.github_mod diff --git a/docs/ref/states/all/salt.states.github.rst b/docs/ref/states/all/salt.states.github.rst deleted file mode 100644 index 76ce26f6..00000000 --- a/docs/ref/states/all/salt.states.github.rst +++ /dev/null @@ -1,5 +0,0 @@ -salt.states.github -================== - -.. automodule:: salt.states.github - :members: diff --git a/docs/ref/states/saltext.github.states.github_mod.rst b/docs/ref/states/saltext.github.states.github_mod.rst deleted file mode 100644 index dddf349a..00000000 --- a/docs/ref/states/saltext.github.states.github_mod.rst +++ /dev/null @@ -1,5 +0,0 @@ -``github`` -========== - -.. automodule:: saltext.github.states.github_mod - :members: diff --git a/docs/ref/states/saltext.github.states.rst b/docs/ref/states/saltext.github.states.rst deleted file mode 100644 index 510ccc5b..00000000 --- a/docs/ref/states/saltext.github.states.rst +++ /dev/null @@ -1,6 +0,0 @@ - -saltext.github.states.github_mod -================================ - -.. automodule:: saltext.github.states.github_mod - :members: diff --git a/docs/ref/utils/all.rst b/docs/ref/utils/all.rst deleted file mode 100644 index 70d9a1f0..00000000 --- a/docs/ref/utils/all.rst +++ /dev/null @@ -1,11 +0,0 @@ - -.. all-saltext.github.utils: - -____________ -Util Modules -____________ - -.. autosummary:: - :toctree: - - saltext.github.utils.github diff --git a/src/saltext/github/utils/github.py b/src/saltext/github/utils/github.py index a51e44b4..b3f87c5e 100644 --- a/src/saltext/github/utils/github.py +++ b/src/saltext/github/utils/github.py @@ -18,7 +18,7 @@ def get_user_pubkeys(users): Some example data structures that coupld be passed in would look like: - .. code_block:: yaml + .. code-block:: yaml ['user1', 'user2', 'user3']