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
epubandsinglehtml(#201). - Adjust default RST output to work better with Spinx's LaTeX builder (#195).
- Allow specifying wildcards for the collection names for the
collectionssubcommand if--use-currentis 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.builtinplugins and modules to explain FQCN and link to thecollectionkeyword docs (#218). - Improve the info box for modules, plugins, and roles in collections to show note that they are not included in
ansible-coreand 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-docof 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
currentsubcommand now has a--skip-ansible-builtinoption which skips building documentation foransible.builtin(#215). - Use same colors for LaTeX builder's output as for HTML builder's output (#199).
Deprecated Features
- The
--use-html-blobsfeature that inserts HTML blobs for the options and return value tables for theansible-docsiteoutput 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 theantsibull-docs repository <https://github.com/ansible-community/antsibull-docs/issues/>__ and provide good reasons for it (#217).
Bugfixes
- Document and ensure that the
collectionsubcommand with `--use-current`` can only be used with collection names (#214). - Fix FQCN detection (#214).
- The
collectionsubcommand claimed to support paths to directories, which was never supported. Removed the mention of paths from the help, and added validation (#214). - The
pluginsubcommand 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--versionoption (#209). - When running
antsibull-docs --version, the correct version is now shown also for editable installs and other installs that do not allowimportlib.metadatato show the correct version (#209). - When using the
action_grouporplatformattributes 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).