You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/lib/ansible/utils
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)
7 years ago
..
module_docs_fragments Docs: Add a "seealso" section to the module docs (#45949) 7 years ago
__init__.py limit extensions for files in group/host_vars dir 11 years ago
cmd_functions.py ansible/utils/: PEP8 compliancy (#24686) 9 years ago
color.py Fix several things causing tracebacks with unicode cwd (#27731) 9 years ago
display.py Fix error reporting on bad type for config setting 8 years ago
encrypt.py Share the implementation of hashing for both vars_prompt and password_hash (#21215) 8 years ago
hashing.py Surround top-level function and class definitions with two blank lines. 8 years ago
helpers.py skip all hidden keys, allow exclude list 9 years ago
jsonrpc.py Refactor junos modules to Use netconf and cliconf plugins (#32621) 8 years ago
listify.py ansible/utils/: PEP8 compliancy (#24686) 9 years ago
path.py fix paths to actually be config file relative (#31533) 8 years ago
plugin_docs.py Docs: Add a "seealso" section to the module docs (#45949) 7 years ago
py3compat.py Normalize config from environment as text strings 8 years ago
shlex.py Update module_utils.six to latest (#22855) 9 years ago
ssh_functions.py Fix encoding error with path to ssh 8 years ago
unicode.py Remove deprecated code (#34828) 8 years ago
unsafe_proxy.py [stable-2.7] Handle sets differently than lists in wrap_var. Fixes #47372 (#47510). 7 years ago
vars.py Expose verbosity as a var, dedupe attr list. Fixes #36170 8 years ago