2.24.0

Release Summary

Feature release to improve linting.

Minor Changes

• Allow to output linting results as JSON (#437).
• When copying collections to a temporary directory for reading their documentation with ansible-doc, detect whether they are part of Git repositories, and if yes, do not copy ignored files (#438).

2.23.1

Release Summary

Bugfix release.

Bugfixes

• Do not reject role argument specs that use mutually_exclusive, required_one_of, required_by, required_if, or required_together (#434, #435).

2.23.0

Release Summary

Feature release.

Minor Changes

• Add new RST roles :ansoptref: and :ansretvalref: which allow to reference options and return values with explicit titles (#430).

2.22.1

Release Summary

Maintenance release.

Bugfixes

• Adjust docs.ansible.com URLs to the new projects/ structure (#428).

2.22.0

Release Summary

Bugfix and maintenance release.

Minor Changes

• Declare support for Python 3.14 (#425).
• Uses new logging framework provided by antsibull-core. This currently has no user-observable impact, but that will change with later versions of antsibull-core (#414).
• antsibull-docs now depends on antsibull-core 3.5.0+ (#414).

Bugfixes

• Remove unnecessary part from template (#423).

2.21.0

Release Summary

Feature release.

Minor Changes

• Add an index for all deprecated collections (official docsite only) and plugins (#413).

2.20.0

Release Summary

Bugfix and feature release.

Minor Changes

• Add --config parameter to the ansible-output subcommand to allow specifying a config file when not in collection mode (#410).
• Add ansible-output-meta directive that allows to apply meta actions, like resetting previous code blocks for variable references, or defining templates for ansible-output-data (#409).
• Allow to specify YAML inventory for ansible-output subcommand code blocks (#411).
• Let ansible-output subcommand run ansible-playbook instances in parallel (#407, #408).

Bugfixes

• Run the post-processors in the ansible-output subcommand from the current working directory, and not from the temporary playbook directory. This allows post-processors to have relative paths from where antsibull-docs ansible-output is called (#406).

2.19.1

Release Summary

Bugfix release for official docsite build.

Bugfixes

• Remove ansible._protomatter from the collection list if no plugins are found for it and it has not been explicitly added to the collection list (#405).
• Remove old hint on configuration settings precedence. The new note makes this one superfluous (#404).

2.19.0

Release Summary

Bugfix and feature release.

Minor Changes

• Add a new subcommand ansible-output which allows to render Ansible output into RST code blocks (#397, #401, #402).
• Antsibull-docutils 1.3.0+ is now an explicit dependency (#395).
• For plugin options that can be configured through other means (Ansible variables, INI entries, environment variables, keywords, CLI arguments), show a notice on precedence below the plugin's parameters if more than one such way is present for an option (#400, #403).
• When linting extra docs, verify that files referenced in toctrees exist (#398, #395).

Bugfixes

• Fix bug that hid keyword config for plugin options for options that are only configurable this way (#403).

2.18.0

Release Summary

Feature and bugfix release.

Minor Changes

• Add :anscollection: role to allow referencing collections. The syntax is :anscollection:`namespace.name`, or
  :anscollection:`namespace.name#what` for more specific parts of the index page
  (#393).
• Extend :ansplugin: role to allow referencing role entrypoints. The syntax is :ansplugin:`namespace.name.role_name#entrypoint`
  (#393).
• The lint-collection-docs subcommand has a new option --check-extra-docs-refs that checks references to collections in extra documentation files (docs/docsite/rst) (#392).
• The lint-collection-docs's option --plugin-docs now also checks role entrypoints for existence (#392).

Deprecated Features

• The following default values for options to antsibull-docs lint-collection-docs are deprecated
  and will change in antsibull-docs 3.0.0:

  • --plugin-docs will be enabled by default; right now the default is --no-plugin-docs;
  • --skip-rstcheck will be enabled by default; right now the default is --no-skip-rstcheck (note that this applies to --plugin-docs, not to checking extra documentation);
  • --check-extra-docs-refs will be enabled by default; right now the default is --no-check-extra-docs-refs.

  We suggested to already now explicitly state the default value if you do not want the extra checks to be run
  (#394).

Bugfixes

• Ansible-core 2.19 now lists standard Jinja2 tests and filters as members of ansible.builtin with minimal documentation, but without a name field in doc (#393).