2.17.1

Release Summary

Bugfix release with updated antsibull-fileutils dependency.

Bugfixes

• Using the new util from antsibull-fileutils >= 1.3.0 to prevent copying the collections tree into a temporary directory structure that already lives inside a ansible_collections tree, which triggers a bug in ansible-core (#391).

2.17.0

Release Summary

Feature and bugfix release.

Minor Changes

• Extend deprecation/removal note that collections can be installed manually after removal (#371).

Bugfixes

• Make sure that all errors are caught during documentation normalization. Until now exceptions derived from BaseException that are not derived from Exception are not handled correctly (#389).

2.16.3

Release Summary

Bugfix release.

Bugfixes

• Fix rendering of HORIZONTALLINE in reStructuredText output. An earlier fix for leading whitespace mangled the resulting raw directive (#370).
• When choices are provided as a dictionary with explanations, links to options, return values, modules, plugins, and roles were not correctly rendered (#369).

2.16.2

Release Summary

Bugfix release.

Bugfixes

• Fix role section heading levels. Examples and attributes should be below role entrypoints (#366, #367).

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).

2.16.0

Release Summary

Feature release.

Minor Changes

• Allow to cancel collection deprecations (#352).
• Declare support for Python 3.13 (#349).
• antsibull-docs now depends on antsibull-core >= 3.4.0 (#352).

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://github.com/ansible-community/antsibull-core/pull/333, https://github.com/ansible-community/antsibull-core/pull/344).
• This project now depends on antsibull-core >= 3.2.0 and pydantic 2 (#330).
• Use Proxy configuration settings from the environment. Check out the aiohttp documentation on Proxy support for information on which environment variables are supported (ansible/ansible-documentation#1936, #346).
• Use language ini for example INI code blocks (#335).
• When rendering the Ansible docsite with the stable and devel subcommands, information on deprecated collections is shown (ansible-community/ansible-build-data#450, #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, #341).

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).
• Add deprecation markers next to module/plugin/role descriptions in lists (#141, #320).
• Remove ansible-project Google Groups mailing list from ansible.builtin links (#325).

2.13.1

Release Summary

Bugfix release.

Bugfixes

• The output filename used by the plugin subcommand contained two dots before the rst extension (#317, #318).

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, #308).
• Bump minimal required version of dependency antsibull-docs-parser to 1.1.0 This allows to use a new whitespace-removal feature (#312).
• If you are using argcomplete, you can now tab-complete antsibull-docs command lines. See 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).
• 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).
• No longer use rsync when creating a build script with the sphinx-init subcommand (#315).
• Remove superfluous whitespace or escaped spaces from templates (#313).
• Remove trailing whitespace and leading and trailing empty lines from rendered templates, and ensure they end with a newline if not empty (#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).