Skip to content

Commit

Permalink
Add changelog fragment and prepare templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfontein committed Sep 23, 2024
1 parent f866406 commit 54d4630
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 0 deletions.
3 changes: 3 additions & 0 deletions changelogs/fragments/341-removed-collections.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
minor_changes:
- "When rendering the Ansible docsite with the ``stable`` and ``devel`` subcommands, stub pages for removed collections are added
(https://github.com/ansible-community/ansible-build-data/pull/459, https://github.com/ansible-community/antsibull-docs/pull/341)."
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{#
Copyright (c) Ansible Project
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
#}

:orphan:

{% if antsibull_docs_version %}
.. meta::
:antsibull-docs: @{ antsibull_docs_version }@

{% endif %}

.. _plugins_in_@{collection_name}@:

@{collection_name.title()}@
@{ '=' * (collection_name | column_width) }@

This collection has been removed from Ansible @{ collection_removal_version.major }@.

If you want to continue using this collection, you can install it manually using
@{ collection | collection_install | rst_code }@.
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ These are the collections documented here in the **@{ namespace }@** namespace.

{% for name in collections | sort %}
* :ref:`@{ namespace }@.@{ name }@ <plugins_in_@{ namespace }@.@{ name }@>` @{ collection_deprecation_marker(collection_metadata[namespace ~ '.' ~ name]) }@
{% else %}
There is no collection in this namespace.
{% endfor %}

{% if breadcrumbs %}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{#
Copyright (c) Ansible Project
GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
SPDX-License-Identifier: GPL-3.0-or-later
#}

{% if antsibull_docs_version %}
.. Created with antsibull-docs @{ antsibull_docs_version }@
{% else %}
.. Created with antsibull-docs
{% endif %}

@{collection_name.title()}@
@{ '=' * (collection_name | column_width) }@

This collection has been removed from Ansible @{ collection_removal_version.major }@.

If you want to continue using this collection, you can install it manually using
@{ collection | collection_install | rst_code }@.
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,6 @@ These are the collections documented here in the **@{ namespace }@** namespace.

{% for name in collections | sort %}
* `@{ namespace }@.@{ name }@ <namespace/index.rst>`_
{% else %}
There is no collection in this namespace.
{% endfor %}

0 comments on commit 54d4630

Please sign in to comment.