ansible/docs/docsite/rst
John R Barker 04e816e13b Stricter module documentation validation (#22353)
Raise the bar for module `DOCUMENTAION`
This validator update was used to find the issues in https://github.com/ansible/ansible/pull/22297/files

**Validation**
* Updated Validation and docs to enforce more (items fixed in https://github.com/ansible/ansible/pull/22297/files)
* Use `suboptions` to document complex options 
* Validate module name
* Validate deprecated modules have correct ANSIBLE_METADATA

**Module Documentation Generation**
* Document `suboptions:` Example https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718
* Tidy up HTML generation (valid HTML, no empty lists, etc)
 
**Documentation**
* Clarify the steps for deprecating a module
* Use correct RST headings
* Document `suboptions:` (options)
* Document `contains:` (returns)


**Details**
The aim is to get this (and corresponding module updates) complete by the time `devel` becomes `2.4`, as this allows us to raise the bar for new modules

Example `suboptions` https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718

The aim is to get this PR integrated into `devel` *before* we branch `stable-2.3`, this will allows us to:
* Raise the bar for new modules in 2.4
* Ensure the generated module documentation for 2.3 and higher is improved, important as we will be doing versioned docs moving forward.
2017-03-13 19:49:27 +00:00
..
dev_guide Stricter module documentation validation (#22353) 2017-03-13 19:49:27 +00:00
modules
roadmap Update ROADMAP_2_3.rst 2017-03-13 14:01:14 -04:00
become.rst
committer_guidelines.rst
common_return_values.rst
community.rst Update dead support link (#22212) 2017-03-02 23:29:19 -08:00
conf.py
faq.rst
galaxy.rst
glossary.rst
guide_aws.rst Added example of referring to AWS-credentials (#21560) 2017-03-05 01:25:39 -08:00
guide_azure.rst
guide_cloudstack.rst
guide_docker.rst
guide_gce.rst
guide_rax.rst
guide_rolling_upgrade.rst
guide_vagrant.rst
guides.rst
index.rst
intro.rst
intro_adhoc.rst
intro_bsd.rst
intro_configuration.rst
intro_dynamic_inventory.rst
intro_getting_started.rst Add document about connecting to localhost (#20534) 2017-03-08 19:45:23 -08:00
intro_installation.rst
intro_inventory.rst fixed ungrouped definition 2017-03-07 12:50:35 -05:00
intro_networking.rst
intro_patterns.rst
intro_windows.rst ansible_winrm_kerberos_delegation (#22113) 2017-03-03 09:51:40 +00:00
modules.rst
modules_intro.rst
modules_support.rst
playbooks.rst
playbooks_acceleration.rst
playbooks_advanced_syntax.rst
playbooks_async.rst
playbooks_best_practices.rst
playbooks_blocks.rst
playbooks_checkmode.rst
playbooks_conditionals.rst
playbooks_debugger.rst
playbooks_delegation.rst
playbooks_environment.rst
playbooks_error_handling.rst
playbooks_filters.rst
playbooks_filters_ipaddr.rst
playbooks_intro.rst doc: Document --syntax-check flag for ansible-playbook (#22256) 2017-03-04 11:11:41 -08:00
playbooks_lookups.rst Fix Docs build issues (#22295) 2017-03-05 11:41:29 +00:00
playbooks_loops.rst Standardizing syntax for 'Playbook Loops' documentation (#20863) 2017-03-06 14:39:07 -08:00
playbooks_prompts.rst
playbooks_roles.rst
playbooks_special_topics.rst
playbooks_startnstep.rst
playbooks_strategies.rst
playbooks_tags.rst
playbooks_templating.rst
playbooks_tests.rst
playbooks_variables.rst
playbooks_vault.rst
porting_guide_2.0.rst
python_3_support.rst
quickstart.rst
test_strategies.rst
tower.rst
YAMLSyntax.rst Add some additional value quoting examples (#20464) 2017-03-05 01:27:54 -08:00