mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 05:42:50 +00:00
Enable documentation in plugins
Made ansible-doc more plugin agnostic We can have docs in lookup, callback, connectionm strategy, etc Use first docstring and make pepizis happy generalized module_docs to plugin_docs documented cartesian, ssh, default, jsonfile, etc as examples changed lack of docs to warning when listing made smarter about bad docstrings better blacklisting added handling of options/config/envs/etc move blacklist to find_plugins, only need once
This commit is contained in:
10
lib/ansible/plugins/cache/jsonfile.py
vendored
10
lib/ansible/plugins/cache/jsonfile.py
vendored
@@ -14,7 +14,15 @@
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
'''
|
||||
DOCUMENTATION:
|
||||
cache: jsonfile
|
||||
short_description: File backed, JSON formated.
|
||||
description:
|
||||
- File backed cache that uses JSON as a format, the files are per host.
|
||||
version_added: "1.9"
|
||||
author: Brian Coca (@bcoca)
|
||||
'''
|
||||
# Make coding more python3-ish
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
11
lib/ansible/plugins/cache/memory.py
vendored
11
lib/ansible/plugins/cache/memory.py
vendored
@@ -14,6 +14,17 @@
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
'''
|
||||
DOCUMENTATION:
|
||||
cache: memory
|
||||
short_description: RAM backed, non persistent
|
||||
description:
|
||||
- RAM backed cache that is not persistent.
|
||||
version_added: historical
|
||||
author: core team (@ansible-core)
|
||||
'''
|
||||
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
9
lib/ansible/plugins/cache/pickle.py
vendored
9
lib/ansible/plugins/cache/pickle.py
vendored
@@ -14,6 +14,15 @@
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
'''
|
||||
DOCUMENTATION:
|
||||
cache: yaml
|
||||
short_description: File backed, using Python's pickle.
|
||||
description:
|
||||
- File backed cache that uses Python's pickle serialization as a format, the files are per host.
|
||||
version_added: "2.3"
|
||||
author: Brian Coca (@bcoca)
|
||||
'''
|
||||
|
||||
# Make coding more python3-ish
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
|
||||
9
lib/ansible/plugins/cache/yaml.py
vendored
9
lib/ansible/plugins/cache/yaml.py
vendored
@@ -14,6 +14,15 @@
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
'''
|
||||
DOCUMENTATION:
|
||||
cache: yaml
|
||||
short_description: File backed, YAML formated.
|
||||
description:
|
||||
- File backed cache that uses YAML as a format, the files are per host.
|
||||
version_added: "2.3"
|
||||
author: Brian Coca (@bcoca)
|
||||
'''
|
||||
|
||||
# Make coding more python3-ish
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
|
||||
Reference in New Issue
Block a user