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/docs/templates
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
6 years ago
..
cli_rst.j2 Fix py3 docs build (#33345) 7 years ago
config.rst.j2 doc: fix link to ansible-config (#49597) 6 years ago
list_of_CATEGORY_modules.rst.j2 [WIP] disambiguating autogenerated module docs attempted fix of #38439. (#38890) 6 years ago
list_of_CATEGORY_plugins.rst.j2 Some more fixes for the docs :ref: disambiguation 6 years ago
man.j2 Fix man page template typo. (#48585) 6 years ago
modules_by_category.rst.j2 Reduce warnings (#39254) 6 years ago
modules_by_support.rst.j2 Reduce warnings (#39254) 6 years ago
playbooks_keywords.rst.j2 Last docs link fixes (#39391) 6 years ago
plugin.rst.j2 Docs: Add a "seealso" section to the module docs (#45949) 6 years ago
plugins_by_category.rst.j2 Generate plugin rst (#28901) 7 years ago
plugins_by_support.rst.j2 Generate plugin rst (#28901) 7 years ago