ansible/test/sanity/validate-modules
Dag Wieers a22f46bacf 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

(cherry picked from commit baf0ad2309)
2019-01-28 10:13:05 -08:00
..
__init__.py
ignore.txt added missing docs for option in acl module (#50775) 2019-01-14 12:34:39 -08:00
main.py [stable-2.7] Prevent metadata changes in a stable branch (#48994) (#49131) 2018-11-26 14:34:13 -06:00
module_args.py Use arg_spec type for comparisons on default and choices (#37741) 2018-03-26 12:15:32 -05:00
schema.py Docs: Add a "seealso" section to the module docs (#45949) 2019-01-28 10:13:05 -08:00
skip.txt Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
test_validate_modules_regex.py Fix shebangs and file modes and update tests. (#40563) 2018-05-22 14:25:36 -07:00
utils.py AnsiballZ improvements 2018-07-26 20:07:25 -07:00
validate-modules