community.general/lib/ansible/utils
Dag Wieers baf0ad2309 Docs: Add a "seealso" section to the module docs (#45949)
* Docs: Add a separate  "seealso" section to the module docs
to list related modules and/or related references. This clears up the notes
section for things that are actual notes.

So you can add a section in your module documentation and four types of
references are possible.

    seealso:

    # Reference by module name
    - module: aci_tenant

    # Reference by module name, including description
    - module: aci_tenant
      description: ACI module to create tenants on a Cisco ACI fabric.

    # Reference by rST documentation anchor
    - ref: aci_guide
      description: Detailed information on how to manage your ACI infrastructure using Ansible.

    # Reference by Internet resource
    - name: APIC Management Information Model reference
      description: Complete reference of the APIC object model.
      link: https://developer.cisco.com/docs/apic-mim-ref/

This PR also includes:

- Implements ansible-doc support
- Implements schema support for the seealso options
- Updates to the development documentation
- Rename filter convert_symbols_to_format to rst_ify, cfr the existing html_ify and tty_ify filters
  - This makes the existing template a lot easier to read and fixes the confusion I had myself rereading the template (again).
- We fixed the possible suboption types (which was limited to 'bool' only)

* Use latest stable instead of devel docs
2018-12-12 14:19:58 -06:00
..
module_docs_fragments Docs: Add a "seealso" section to the module docs (#45949) 2018-12-12 14:19:58 -06:00
__init__.py
_build_helpers.py Docs: Make docsite rebuilds smarter/faster (#45062) 2018-09-12 13:50:36 -07:00
cmd_functions.py ansible/utils/: PEP8 compliancy (#24686) 2017-05-30 18:09:44 +01:00
color.py Fix several things causing tracebacks with unicode cwd (#27731) 2017-08-04 09:25:08 -04:00
display.py Fix spelling error in Display.banner description (#49790) 2018-12-11 15:00:15 -06:00
encrypt.py Add a Singleton metaclass, use it with Display (#48935) 2018-11-20 17:06:51 -06:00
hashing.py Enable additional pylint rules and resolve issues found. (#47221) 2018-10-18 13:38:08 -07:00
helpers.py skip all hidden keys, allow exclude list 2017-08-28 12:56:14 -04:00
jsonrpc.py Remove cliconf from httpapi connection (#46813) 2018-12-11 16:26:59 -05:00
listify.py Python 3.8 collections compatibility fixes. 2018-10-08 11:26:37 -07:00
path.py fix paths to actually be config file relative (#31533) 2017-10-10 19:17:17 -07:00
plugin_docs.py Docs: Add a "seealso" section to the module docs (#45949) 2018-12-12 14:19:58 -06:00
py3compat.py Python 3.8 collections compatibility fixes. 2018-10-08 11:26:37 -07:00
shlex.py Update module_utils.six to latest (#22855) 2017-03-23 13:35:05 -07:00
singleton.py Add a Singleton metaclass, use it with Display (#48935) 2018-11-20 17:06:51 -06:00
ssh_functions.py Fix encoding error with path to ssh 2017-09-22 15:31:21 -07:00
unicode.py Remove deprecated code (#34828) 2018-01-23 12:02:09 -06:00
unsafe_proxy.py Handle sets differently than lists in wrap_var. Fixes #47372 (#47510) 2018-10-23 11:18:21 -05:00
vars.py Python 3.8 collections compatibility fixes. 2018-10-08 11:26:37 -07:00