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
John R Barker a23c95023b
Module deprecation: docs, scheme and tests (#34100)
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.

* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index

To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
    removed_module()
```
7 years ago
..
cli_rst.j2 Fix py3 docs build (#33345) 7 years ago
config.rst.j2 Fix various RST warnings (#34084) 7 years ago
list_of_CATEGORY_modules.rst.j2 Fix modules index delimiter and improve readability (#35187) 7 years ago
list_of_CATEGORY_plugins.rst.j2 Fix modules index delimiter and improve readability (#35187) 7 years ago
man.j2 Fix sorting in man template on python3. Fixes #33663 (#33673) 7 years ago
modules_by_category.rst.j2 Revamp the plugin_formatter doc generator 7 years ago
modules_by_support.rst.j2 Misc docs fixes 7 years ago
playbooks_keywords.rst.j2 Keywords docs (#32807) 7 years ago
plugin.rst.j2 Module deprecation: docs, scheme and tests (#34100) 7 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