ansible-community/antsibull-docs (antsibull-docs)
### [`v2.16.1`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.16.1)
[Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.16.0...2.16.1)
##### Release Summary
Bugfix release.
##### Bugfixes
- Also consider action plugin redirects/deprecations in runtime metadata for modules, since for users there is no difference. Also ansible.builtin.yum only has a action plugin redirect to ansible.builtin.dnf, so this is needed to ensure that a stub page generated for ansible.builtin.yum ([#360](https://redirect.github.com/ansible-community/antsibull-docs/pull/360)).
### [`v2.16.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.16.0)
[Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.15.0...2.16.0)
##### Release Summary
Feature release.
##### Minor Changes
- Allow to cancel collection deprecations ([#352](https://redirect.github.com/ansible-community/antsibull-docs/pull/352)).
- Declare support for Python 3.13 ([#349](https://redirect.github.com/ansible-community/antsibull-docs/pull/349)).
- antsibull-docs now depends on antsibull-core >= 3.4.0 ([#352](https://redirect.github.com/ansible-community/antsibull-docs/pull/352)).
### [`v2.15.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.15.0)
[Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.14.0...2.15.0)
##### Release Summary
Bugfix and feature release which migrates to Pydantic 2.
##### Minor Changes
- Migrated all models to Pydantic 2. This is mostly transparent, except that validation error messages slightly change, and that some validation is more strict. For example, if a boolean is used instead of a string, say in a description, this now results in an error instead of a silent coercion. Numbers are still accepted for strings (for example version_added with float values like 2.14) ([#331](https://redirect.github.com/ansible-community/antsibull-docs/pull/331), [ansible-community/antsibull-core#333](https://redirect.github.com/ansible-community/antsibull-core/pull/333), [ansible-community/antsibull-core#344](https://redirect.github.com/ansible-community/antsibull-core/pull/344)).
- This project now depends on antsibull-core >= 3.2.0 and pydantic 2 ([#330](https://redirect.github.com/ansible-community/antsibull-docs/pull/330)).
- Use Proxy configuration settings from the environment. Check out the [aiohttp documentation on Proxy support](https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support) for information on which environment variables are supported ([ansible/ansible-documentation#1936](https://redirect.github.com/ansible/ansible-documentation/issues/1936), [#346](https://redirect.github.com/ansible-community/antsibull-docs/pull/346)).
- Use language ini for example INI code blocks ([#335](https://redirect.github.com/ansible-community/antsibull-docs/pull/335)).
- When rendering the Ansible docsite with the stable and devel subcommands, information on deprecated collections is shown ([ansible-community/ansible-build-data#450](https://redirect.github.com/ansible-community/ansible-build-data/pull/450), [#330](https://redirect.github.com/ansible-community/antsibull-docs/pull/330)).
- When rendering the Ansible docsite with the stable and devel subcommands, stub pages for removed collections are added ([ansible-community/ansible-build-data#459](https://redirect.github.com/ansible-community/ansible-build-data/pull/459), [#341](https://redirect.github.com/ansible-community/antsibull-docs/pull/341)).
### [`v2.14.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.14.0)
[Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.13.1...2.14.0)
##### Release Summary
Feature release.
##### Minor Changes
- Add dependency on antsibull-fileutils. Some functionality from antsibull-core is moving there, so we can use it from there directly ([#322](https://redirect.github.com/ansible-community/antsibull-docs/pull/322)).
- Add deprecation markers next to module/plugin/role descriptions in lists ([#141](https://redirect.github.com/ansible-community/antsibull-docs/issues/141), [#320](https://redirect.github.com/ansible-community/antsibull-docs/pull/320)).
- Remove ansible-project Google Groups mailing list from ansible.builtin links ([#325](https://redirect.github.com/ansible-community/antsibull-docs/pull/325)).
### [`v2.13.1`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.13.1)
[Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.13.0...2.13.1)
##### Release Summary
Bugfix release.
##### Bugfixes
- The output filename used by the plugin subcommand contained two dots before the rst extension ([#317](https://redirect.github.com/ansible-community/antsibull-docs/issues/317), [#318](https://redirect.github.com/ansible-community/antsibull-docs/pull/318)).
### [`v2.13.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.13.0)
[Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.12.0...2.13.0)
##### Release Summary
Bugfix and feature release.
##### Minor Changes
- Allow to disable adding the antsibull-docs version to the generated files with the --no-add-antsibull-docs-version command line flag, or the add_antsibull_docs_version = false setting in the antsibull-docs config file ([#304](https://redirect.github.com/ansible-community/antsibull-docs/issues/304), [#308](https://redirect.github.com/ansible-community/antsibull-docs/pull/308)).
- Bump minimal required version of dependency antsibull-docs-parser to 1.1.0 This allows to use a new whitespace-removal feature ([#312](https://redirect.github.com/ansible-community/antsibull-docs/pull/312)).
- If you are using [argcomplete](https://pypi.org/project/argcomplete/), you can now tab-complete antsibull-docs command lines. See [Activating global completion](https://pypi.org/project/argcomplete/#activating-global-completion) in the argcomplete README for how to enable tab completion globally. This will also tab-complete Ansible commands such as ansible-playbook and ansible-test ([#302](https://redirect.github.com/ansible-community/antsibull-docs/pull/302)).
- Most documentation generating subcommands now have a --cleanup parameter which allows to delete files and directories that were not created by antsibull-docs in the destination directory ([#315](https://redirect.github.com/ansible-community/antsibull-docs/pull/315)).
- No longer use rsync when creating a build script with the sphinx-init subcommand ([#315](https://redirect.github.com/ansible-community/antsibull-docs/pull/315)).
- Remove superfluous whitespace or escaped spaces from templates ([#313](https://redirect.github.com/ansible-community/antsibull-docs/pull/313)).
- Remove trailing whitespace and leading and trailing empty lines from rendered templates, and ensure they end with a newline if not empty ([#314](https://redirect.github.com/ansible-community/antsibull-docs/pull/314)).
##### Bugfixes
- Fix RST escaping of the title in the collections per namespace list. This causes a space to vanish between namespace name and the word Namespace with newer versions of antsibull-docs-parser ([#311](https://redirect.github.com/ansible-community/antsibull-docs/pull/311)).
### [`v2.12.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.12.0)
[Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.11.0...2.12.0)
##### Release Summary
Bugfix and feature release.
##### Minor Changes
- Allow to mention forums in the Communication section of collection links ([#288](https://redirect.github.com/ansible-community/antsibull-docs/pull/288)).
- Bump minimum dependency of antsibull-docs-parser to 1.0.2 or newer ([#290](https://redirect.github.com/ansible-community/antsibull-docs/pull/290)).
- The lint-collection-docs subcommand will now complain about unchanged default values in docs/docsite/links.yml taken from the [community collection template](https://redirect.github.com/ansible-collections/collection_template/) ([#273](https://redirect.github.com/ansible-community/antsibull-docs/issues/273), [#277](https://redirect.github.com/ansible-community/antsibull-docs/pull/277)).
- The collection docs linter now reports empty markup, like I(), L(,https://example.com) ([#292](https://redirect.github.com/ansible-community/antsibull-docs/pull/292)).
##### Bugfixes
- Improve handling of empty markup parameters for RST ([#290](https://redirect.github.com/ansible-community/antsibull-docs/pull/290)).
- Improve rendering of empty or broken changelogs ([#289](https://redirect.github.com/ansible-community/antsibull-docs/pull/289)).
- Remove leading spaces in paragraphs to avoid unintended RST blockquotes ([#289](https://redirect.github.com/ansible-community/antsibull-docs/pull/289)).
- Render errors as code blocks of language text instead of using the default lexer ([#289](https://redirect.github.com/ansible-community/antsibull-docs/pull/289)).
### [`v2.11.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.11.0)
[Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.10.0...2.11.0)
##### Release Summary
Feature and bugfix release.
##### Minor Changes
- Support examples for role entrypoints ([#244](https://redirect.github.com/ansible-community/antsibull-docs/pull/244)).
##### Bugfixes
- Fix handling of choices that are dictionaries for type=list ([#276](https://redirect.github.com/ansible-community/antsibull-docs/pull/276)).
- Fix handling of default for type=list if choices is present ([#276](https://redirect.github.com/ansible-community/antsibull-docs/pull/276)).
### [`v2.10.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.10.0)
[Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.9.0...2.10.0)
##### Release Summary
Bugfix and feature release.
##### Minor Changes
- It is now possible to render the collection changelog as part of the collection docsite by using the changelog option in docs/docsite/config.yml ([#31](https://redirect.github.com/ansible-community/antsibull-docs/issues/31), [#267](https://redirect.github.com/ansible-community/antsibull-docs/pull/267)).
##### Bugfixes
- Fix internal links to options and return values in simplified RST output ([#269](https://redirect.github.com/ansible-community/antsibull-docs/pull/269)).
- Include role in role attribute references ([#269](https://redirect.github.com/ansible-community/antsibull-docs/pull/269)).
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR contains the following updates:
==2.9.0
->==2.16.1
Release Notes
ansible-community/antsibull-docs (antsibull-docs)
### [`v2.16.1`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.16.1) [Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.16.0...2.16.1) ##### Release Summary Bugfix release. ##### Bugfixes - Also consider action plugin redirects/deprecations in runtime metadata for modules, since for users there is no difference. Alsoansible.builtin.yum
only has a action plugin redirect toansible.builtin.dnf
, so this is needed to ensure that a stub page generated foransible.builtin.yum
([#360](https://redirect.github.com/ansible-community/antsibull-docs/pull/360)). ### [`v2.16.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.16.0) [Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.15.0...2.16.0) ##### Release Summary Feature release. ##### Minor Changes - Allow to cancel collection deprecations ([#352](https://redirect.github.com/ansible-community/antsibull-docs/pull/352)). - Declare support for Python 3.13 ([#349](https://redirect.github.com/ansible-community/antsibull-docs/pull/349)). - antsibull-docs now depends on antsibull-core >= 3.4.0 ([#352](https://redirect.github.com/ansible-community/antsibull-docs/pull/352)). ### [`v2.15.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.15.0) [Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.14.0...2.15.0) ##### Release Summary Bugfix and feature release which migrates to Pydantic 2. ##### Minor Changes - Migrated all models to Pydantic 2. This is mostly transparent, except that validation error messages slightly change, and that some validation is more strict. For example, if a boolean is used instead of a string, say in a description, this now results in an error instead of a silent coercion. Numbers are still accepted for strings (for exampleversion_added
with float values like2.14
) ([#331](https://redirect.github.com/ansible-community/antsibull-docs/pull/331), [ansible-community/antsibull-core#333](https://redirect.github.com/ansible-community/antsibull-core/pull/333), [ansible-community/antsibull-core#344](https://redirect.github.com/ansible-community/antsibull-core/pull/344)). - This project now depends on antsibull-core >= 3.2.0 and pydantic 2 ([#330](https://redirect.github.com/ansible-community/antsibull-docs/pull/330)). - Use Proxy configuration settings from the environment. Check out the [aiohttp documentation on Proxy support](https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support) for information on which environment variables are supported ([ansible/ansible-documentation#1936](https://redirect.github.com/ansible/ansible-documentation/issues/1936), [#346](https://redirect.github.com/ansible-community/antsibull-docs/pull/346)). - Use languageini
for example INI code blocks ([#335](https://redirect.github.com/ansible-community/antsibull-docs/pull/335)). - When rendering the Ansible docsite with thestable
anddevel
subcommands, information on deprecated collections is shown ([ansible-community/ansible-build-data#450](https://redirect.github.com/ansible-community/ansible-build-data/pull/450), [#330](https://redirect.github.com/ansible-community/antsibull-docs/pull/330)). - When rendering the Ansible docsite with thestable
anddevel
subcommands, stub pages for removed collections are added ([ansible-community/ansible-build-data#459](https://redirect.github.com/ansible-community/ansible-build-data/pull/459), [#341](https://redirect.github.com/ansible-community/antsibull-docs/pull/341)). ### [`v2.14.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.14.0) [Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.13.1...2.14.0) ##### Release Summary Feature release. ##### Minor Changes - Add dependency on antsibull-fileutils. Some functionality from antsibull-core is moving there, so we can use it from there directly ([#322](https://redirect.github.com/ansible-community/antsibull-docs/pull/322)). - Add deprecation markers next to module/plugin/role descriptions in lists ([#141](https://redirect.github.com/ansible-community/antsibull-docs/issues/141), [#320](https://redirect.github.com/ansible-community/antsibull-docs/pull/320)). - Remove ansible-project Google Groups mailing list from ansible.builtin links ([#325](https://redirect.github.com/ansible-community/antsibull-docs/pull/325)). ### [`v2.13.1`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.13.1) [Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.13.0...2.13.1) ##### Release Summary Bugfix release. ##### Bugfixes - The output filename used by theplugin
subcommand contained two dots before therst
extension ([#317](https://redirect.github.com/ansible-community/antsibull-docs/issues/317), [#318](https://redirect.github.com/ansible-community/antsibull-docs/pull/318)). ### [`v2.13.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.13.0) [Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.12.0...2.13.0) ##### Release Summary Bugfix and feature release. ##### Minor Changes - Allow to disable adding the antsibull-docs version to the generated files with the--no-add-antsibull-docs-version
command line flag, or theadd_antsibull_docs_version = false
setting in the antsibull-docs config file ([#304](https://redirect.github.com/ansible-community/antsibull-docs/issues/304), [#308](https://redirect.github.com/ansible-community/antsibull-docs/pull/308)). - Bump minimal required version of dependency antsibull-docs-parser to 1.1.0 This allows to use a new whitespace-removal feature ([#312](https://redirect.github.com/ansible-community/antsibull-docs/pull/312)). - If you are using [argcomplete](https://pypi.org/project/argcomplete/), you can now tab-completeantsibull-docs
command lines. See [Activating global completion](https://pypi.org/project/argcomplete/#activating-global-completion) in the argcomplete README for how to enable tab completion globally. This will also tab-complete Ansible commands such asansible-playbook
andansible-test
([#302](https://redirect.github.com/ansible-community/antsibull-docs/pull/302)). - Most documentation generating subcommands now have a--cleanup
parameter which allows to delete files and directories that were not created by antsibull-docs in the destination directory ([#315](https://redirect.github.com/ansible-community/antsibull-docs/pull/315)). - No longer usersync
when creating a build script with thesphinx-init
subcommand ([#315](https://redirect.github.com/ansible-community/antsibull-docs/pull/315)). - Remove superfluous whitespace or escaped spaces from templates ([#313](https://redirect.github.com/ansible-community/antsibull-docs/pull/313)). - Remove trailing whitespace and leading and trailing empty lines from rendered templates, and ensure they end with a newline if not empty ([#314](https://redirect.github.com/ansible-community/antsibull-docs/pull/314)). ##### Bugfixes - Fix RST escaping of the title in the collections per namespace list. This causes a space to vanish between namespace name and the wordNamespace
with newer versions of antsibull-docs-parser ([#311](https://redirect.github.com/ansible-community/antsibull-docs/pull/311)). ### [`v2.12.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.12.0) [Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.11.0...2.12.0) ##### Release Summary Bugfix and feature release. ##### Minor Changes - Allow to mention forums in the Communication section of collection links ([#288](https://redirect.github.com/ansible-community/antsibull-docs/pull/288)). - Bump minimum dependency ofantsibull-docs-parser
to 1.0.2 or newer ([#290](https://redirect.github.com/ansible-community/antsibull-docs/pull/290)). - Thelint-collection-docs
subcommand will now complain about unchanged default values indocs/docsite/links.yml
taken from the [community collection template](https://redirect.github.com/ansible-collections/collection_template/) ([#273](https://redirect.github.com/ansible-community/antsibull-docs/issues/273), [#277](https://redirect.github.com/ansible-community/antsibull-docs/pull/277)). - The collection docs linter now reports empty markup, likeI()
,L(,https://example.com)
([#292](https://redirect.github.com/ansible-community/antsibull-docs/pull/292)). ##### Bugfixes - Improve handling of empty markup parameters for RST ([#290](https://redirect.github.com/ansible-community/antsibull-docs/pull/290)). - Improve rendering of empty or broken changelogs ([#289](https://redirect.github.com/ansible-community/antsibull-docs/pull/289)). - Remove leading spaces in paragraphs to avoid unintended RST blockquotes ([#289](https://redirect.github.com/ansible-community/antsibull-docs/pull/289)). - Render errors as code blocks of languagetext
instead of using the default lexer ([#289](https://redirect.github.com/ansible-community/antsibull-docs/pull/289)). ### [`v2.11.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.11.0) [Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.10.0...2.11.0) ##### Release Summary Feature and bugfix release. ##### Minor Changes - Support examples for role entrypoints ([#244](https://redirect.github.com/ansible-community/antsibull-docs/pull/244)). ##### Bugfixes - Fix handling ofchoices
that are dictionaries fortype=list
([#276](https://redirect.github.com/ansible-community/antsibull-docs/pull/276)). - Fix handling ofdefault
fortype=list
ifchoices
is present ([#276](https://redirect.github.com/ansible-community/antsibull-docs/pull/276)). ### [`v2.10.0`](https://redirect.github.com/ansible-community/antsibull-docs/releases/tag/2.10.0) [Compare Source](https://redirect.github.com/ansible-community/antsibull-docs/compare/2.9.0...2.10.0) ##### Release Summary Bugfix and feature release. ##### Minor Changes - It is now possible to render the collection changelog as part of the collection docsite by using thechangelog
option indocs/docsite/config.yml
([#31](https://redirect.github.com/ansible-community/antsibull-docs/issues/31), [#267](https://redirect.github.com/ansible-community/antsibull-docs/pull/267)). ##### Bugfixes - Fix internal links to options and return values in simplified RST output ([#269](https://redirect.github.com/ansible-community/antsibull-docs/pull/269)). - Include role in role attribute references ([#269](https://redirect.github.com/ansible-community/antsibull-docs/pull/269)).Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.