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

2.3.0

Release Summary

Bugfix and feature release.

Minor Changes

• Add a :ansplugin: role to the Sphinx extension. This allows to reference a module, plugin, or role with the fqcn#type syntax from semantic markup instead of having to manually compose a ansible_collections.{fqcn}_{type} label. An explicit reference title can also be provided with the title <fqcn#type> syntax similar to the :ref: role (#180).
• Add a new subcommand lint-core-docs which lints the ansible-core documentation (#182).
• Add a new subcommand, collection-plugins, for rendering files for all plugins and roles in a collection without any indexes (#177).
• Add support for different output formats. Next to the default format, ansible-docsite, a new experimental format simplified-rst is supported. Experimental means that it will likely change considerably in the next few releases until it stabilizes. Such changes will not be considered breaking changes, and could potentially even be bugfixes (#177).
• Use Dart sass compiler instead of sassc to compile CSS for Sphinx extension (#185, #186).
• When parsing errors happen in the Sphinx extension, the extension now emits error messages during the build process in addition to error markup (#187).

Bugfixes

• Consider module/plugin aliases when linting references to other modules and plugins (#184).
• Make sure that all aliases are actually listed for plugins (#183).
• When looking for redirects, the aliases field and filesystem redirects in ansible-core were not properly considered. This ensures that all redirect stubs are created, and that no duplicates show up, not depending on whether ansible-core is installed in editable mode or not (#183).

2.2.0

Release Summary

Bugfix and feature release improving rendering and linting.

Minor Changes

• Collection docs linter - also validate seealso module and plugin destinations (#168, #171).
• When linting collection plugin docs, make sure that array stubs [...] are used when referencing sub-options or sub-return values inside lists, and are not used outside lists and dictionaries (#173).

Bugfixes

• Fix the way the Sphinx extension creates nodes for options and return values so they look identical for internal references, external (intersphinx) references, and unresolved references (#175).
• Make sure that :ansopt: and :ansretval: create the same references as the labels created in the RST files (#167, #172).
• Make sure that broken :ansopt: and :ansretval: parameters result in correctly rendered error messages (#175).
• When trying to copying descriptions of non-existing plugins to seealso, references to these non-existing plugins were added in some cases, crashing the docs augmentation process (#169).

1.11.1

Release Summary

Bugfix release.

Bugfixes

• Allow role entrypoint deprecations without having to specify the collection the role is removed from (#156).
• Fix the way the Sphinx extension creates nodes for options and return values so they look identical for internal references, external (intersphinx) references, and unresolved references (#175).
• Indent module/plugin and role entrypoint deprecations correctly if 'Why' or 'Alternative' texts need more than one line (#156).
• Make sure that :ansopt: and :ansretval: create the same references as the labels created in the RST files (#167, #172).
• Make sure that broken :ansopt: and :ansretval: parameters result in correctly rendered error messages (#175).
• Use doc_parsing_backend from the application context instead of the library context. This prevents removal of doc_parsing_backend from the antsibull-core library context (#125).
• When collecting collection dependencies for the lint-collection-docs subcommand, a bug prevented the duplicate detection to work (#160).
• When trying to copying descriptions of non-existing plugins to seealso, references to these non-existing plugins were added in some cases, crashing the docs augmentation process (#169).