ansible/docs/docsite/rst/dev_guide
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
..
shared_snippets rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
style_guide Add docs about contributing to docs (#46481) (#47658) 2018-10-26 08:18:42 -05:00
testing/sanity Support skip of platforms by version in tests. (#48826) 2018-12-03 15:42:03 -08:00
debugging.rst adds stub API docs in a single file (#46663) 2018-11-05 15:10:52 -08:00
developing_api.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
developing_core.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
developing_inventory.rst cherrypick for #46786 2018-11-05 15:10:52 -08:00
developing_locally.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
developing_module_utilities.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
developing_modules.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
developing_modules_best_practices.rst adds stub API docs in a single file (#46663) 2018-11-05 15:10:52 -08:00
developing_modules_checklist.rst [stable-2.7] bulk docs update (#47828) 2018-10-30 14:45:41 -05:00
developing_modules_documenting.rst Docs: Add a "seealso" section to the module docs (#45949) 2019-01-28 10:13:05 -08:00
developing_modules_general.rst Add docs about contributing to docs (#46481) (#47658) 2018-10-26 08:18:42 -05:00
developing_modules_general_aci.rst Update developing_modules_general_aci.rst (#46042) 2018-09-22 19:56:25 -05:00
developing_modules_general_windows.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
developing_modules_in_groups.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
developing_plugins.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
developing_program_flow_modules.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
developing_python_3.rst adds stub API docs in a single file (#46663) 2018-11-05 15:10:52 -08:00
developing_rebasing.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
index.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
Makefile
module_lifecycle.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
overview_architecture.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
testing.rst rewrite of the developer guide, part 1 (#45179) (#45349) 2018-09-07 10:35:13 -05:00
testing_compile.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
testing_documentation.rst Add docs about contributing to docs (#46481) (#47658) 2018-10-26 08:18:42 -05:00
testing_httptester.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
testing_integration.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
testing_pep8.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
testing_running_locally.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
testing_sanity.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
testing_units.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
testing_units_modules.rst [WIP] Backport/2.7/batch port (#45859) 2018-09-19 22:02:01 -05:00
testing_validate-modules.rst [stable-2.7] Prevent metadata changes in a stable branch (#48994) (#49131) 2018-11-26 14:34:13 -06:00