2.11.0

Release Summary

Feature and bugfix release.

Minor Changes

• Support examples for role entrypoints (#244).

Bugfixes

• Fix handling of choices that are dictionaries for type=list (#276).
• Fix handling of default for type=list if choices is present (#276).

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, #267).

Bugfixes

• Fix internal links to options and return values in simplified RST output (#269).
• Include role in role attribute references (#269).

2.9.0

Release Summary

Maintenance release.

Minor Changes

• Add support for the antsibull-core v3 (#261).

2.8.0

Release Summary

Bugfix and feature release.

Minor Changes

• Add support for "dark mode" to the option table styling (#253, #258).
• Add support for the latest antsibull-core v3 pre-release, 3.0.0a1 (#250).
• Declare support for Python 3.12 (#255).
• The colors used by the CSS provided by the Antsibull Sphinx extension can now be overridden (#254).

Bugfixes

• Fix duplicate docs detection (for aliases) for latest ansible-core devel (#257).

2.7.0

Release Summary

Bugfix and refactoring release.

Minor Changes

• Explicitly set up Galaxy context instead of relying on deprecated functionality (#234).

Bugfixes

• Fix schema for seealso in role entrypoints. Plugin references now work (#237, #240).
• Make error reporting for invalid references in plugin seealso entries more precise (#240).
• Support new ansible-doc --json output field plugin_name (#242).
• Use certain fields from library context instead of app context that are deprecated in the app context and will be removed from antsibull-core 3.0.0 (#233).

2.6.1

Release Summary

Bugfix release.

Bugfixes

• For role argument specs, allow author, description, and todo to be a string instead of a list of strings, similarly as with ansible-doc and with modules and plugins (#227).
• Make sure that title underlines have the correct width for wide Unicode characters (#228, #229).

2.6.0

Release Summary

Fix parsing of EXAMPLES and improve error message

Minor Changes

• Improve error messages when calls to ansible-doc fail (#223).

Bugfixes

• When EXAMPLES has the format specified by # fmt: <format>, this value is used to determine the code block type (#225).

2.5.0

Release Summary

Release to support the updated Ansible Galaxy codebase.

Minor Changes

• The default collection URL template has been changed from https://galaxy.ansible.com/{namespace}/{name} to https://galaxy.ansible.com/ui/repo/published/{namespace}/{name}/ to adjust for the Galaxy codebase change on September 30th, 2023 (#147, #220).

2.4.0

Release Summary

Bugfix and feature release. Improves support for other builders than html.

There will be a follow-up release after Ansible Galaxy <https://galaxy.ansible.com/>__
switched to the new galaxy_ng codebase, which is scheduled for September 30th.
That release will only adjust the URLs to Galaxy, except potentially bugfixes.

Minor Changes

• Add basic support for other HTML based Sphinx builders such as epub and singlehtml (#201).
• Adjust default RST output to work better with Spinx's LaTeX builder (#195).
• Allow specifying wildcards for the collection names for the collections subcommand if --use-current is specified (#219).
• Antsibull-docs now depends on antsibull-core >= 2.1.0 (#209).
• Create collection links with a custom directive. This makes them compatible with builders other than the HTML builder (#200).
• Fix indent for nested options and return values with Spinx's LaTeX builder (#198).
• Improve linting of option and return value names in semantic markup with respect to array stubs: forbid array stubs for dictionaries if the dictionary is not the last part of the option (#208).
• Improve the info box for ansible.builtin plugins and modules to explain FQCN and link to the collection keyword docs (#218).
• Improve the info box for modules, plugins, and roles in collections to show note that they are not included in ansible-core and show instructions on how to check whether the collection is installed (#218).
• Insert the antsibull-docs version as a comment or metadata into the generated files (#205).
• Make sure that the antsibull Sphinx extension contains the correct version (same as antsibull-docs itself) and licensing information (GPL-3.0-or-later), and that the version is kept up-to-date for new releases (#202).
• Move roles from templates and structural styling from stylesheet to antsibull Sphinx extension. This makes sure that HTML tags such as <strong> and <em> are used for bold and italic texts, and that the same formattings are used for the LaTeX builder (#199).
• Support multiple filters in ansible-doc of ansible-core 2.16 and later. This makes building docsites and linting more efficient when documentation for more than one and less than all installed collections needs to be queried (#193, #213).
• The current subcommand now has a --skip-ansible-builtin option which skips building documentation for ansible.builtin (#215).
• Use same colors for LaTeX builder's output as for HTML builder's output (#199).

Deprecated Features

• The --use-html-blobs feature that inserts HTML blobs for the options and return value tables for the ansible-docsite output format is deprecated and will be removed soon. The HTML tables cause several features to break, such as references to options and return values. If you think this feature needs to stay, please create an issue in the antsibull-docs repository <https://github.com/ansible-community/antsibull-docs/issues/>__ and provide good reasons for it (#217).

Bugfixes

• Document and ensure that the collection subcommand with `--use-current`` can only be used with collection names (#214).
• Fix FQCN detection (#214).
• The collection subcommand claimed to support paths to directories, which was never supported. Removed the mention of paths from the help, and added validation (#214).
• The plugin subcommand claimed to support paths to plugin files, which was never supported. Removed the mention of paths from the help (#214).
• When running antsibull-docs --help, the correct program name is now shown for the --version option (#209).
• When running antsibull-docs --version, the correct version is now shown also for editable installs and other installs that do not allow importlib.metadata to show the correct version (#209).
• When using the action_group or platform attributes in a role, a RST symbol was used that was not defined (#206).

Known Issues

• When using Sphinx builders other than HTML and LaTeX, the indentation for nested options and return values is missing (#195).

2.3.1

Release Summary

Bugfix release with a CSS fix for the Sphinx extension.

Bugfixes

• Fix antsibull Sphinx extension CSS so that the option/return value anchors for module/plugin/role documentation can also be used on WebKit-based browsers such as Gnome Web and Safari (#188, #189).