mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07:00
Docs: adding stub page for module/plugin aliases (#54448)
* Adding stub pages for deprecated module/plugin aliases.
This commit is contained in:
parent
272dceef42
commit
395d471065
2 changed files with 43 additions and 0 deletions
18
docs/templates/plugin_deprecation_stub.rst.j2
vendored
Normal file
18
docs/templates/plugin_deprecation_stub.rst.j2
vendored
Normal file
|
@ -0,0 +1,18 @@
|
|||
:source: @{ source }@
|
||||
|
||||
{# avoids rST "isn't included in any toctree" errors for module docs #}
|
||||
:orphan:
|
||||
|
||||
.. _@{ module }@_@{ plugin_type }@_alias_@{ alias }@:
|
||||
|
||||
{% if short_description %}
|
||||
{% set title = alias + ' -- ' + short_description | rst_ify %}
|
||||
{% else %}
|
||||
{% set title = alias %}
|
||||
{% endif %}
|
||||
|
||||
@{ title }@
|
||||
@{ '+' * title|length }@
|
||||
|
||||
This is an alias for :ref:`@{ module }@ <@{ module }@_@{ plugin_type }@>`.
|
||||
This name has been **deprecated**. Please update your tasks to use the new name ``@{ module }@`` instead.
|
Loading…
Add table
Add a link
Reference in a new issue