mirror of https://github.com/ansible/ansible.git
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.
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
|
7 years ago | |
|---|---|---|
| .. | ||
| api | 7 years ago | |
| community | 7 years ago | |
| dev_guide | 7 years ago | |
| installation_guide | 7 years ago | |
| inventory | 7 years ago | |
| network | 7 years ago | |
| plugins | 7 years ago | |
| porting_guides | 7 years ago | |
| reference_appendices | 7 years ago | |
| roadmap | 7 years ago | |
| scenario_guides | 7 years ago | |
| user_guide | 7 years ago | |
| vmware | 7 years ago | |
| conf.py | 7 years ago | |
| index.rst | 7 years ago | |