ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-24 22:00:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Docs: adding stub page for module/plugin aliases (#54448)

Browse source 
* Adding stub pages for deprecated module/plugin aliases.
This commit is contained in:
Felix Fontein 2019-04-16 18:37:28 +02:00 • committed by Alicia Cozine
commit 395d471065
2 changed files with 43 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/templates/plugin_deprecation_stub.rst.j2 vendored Normal file
View 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.