a22f46bacf
* 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
|
||
---|---|---|
.. | ||
shared_snippets | ||
style_guide | ||
testing/sanity | ||
debugging.rst | ||
developing_api.rst | ||
developing_core.rst | ||
developing_inventory.rst | ||
developing_locally.rst | ||
developing_module_utilities.rst | ||
developing_modules.rst | ||
developing_modules_best_practices.rst | ||
developing_modules_checklist.rst | ||
developing_modules_documenting.rst | ||
developing_modules_general.rst | ||
developing_modules_general_aci.rst | ||
developing_modules_general_windows.rst | ||
developing_modules_in_groups.rst | ||
developing_plugins.rst | ||
developing_program_flow_modules.rst | ||
developing_python_3.rst | ||
developing_rebasing.rst | ||
index.rst | ||
Makefile | ||
module_lifecycle.rst | ||
overview_architecture.rst | ||
testing.rst | ||
testing_compile.rst | ||
testing_documentation.rst | ||
testing_httptester.rst | ||
testing_integration.rst | ||
testing_pep8.rst | ||
testing_running_locally.rst | ||
testing_sanity.rst | ||
testing_units.rst | ||
testing_units_modules.rst | ||
testing_validate-modules.rst |