1.6.0

Release Summary

Bugfix and feature release.

Minor Changes

• Allow to specify choices as dictionary instead of list (#36).
• Use JSON serializer to format choices (#37).
• Use special serializer to format INI values in examples (#37).

Bugfixes

• Avoid collection names with _ in them appear wrongly escaped in the HTML output (#41).
• For INI examples which have no default, write VALUE as intended instead of None (#37).
• Format lists correctly for INI examples (#37).
• The sphinx-init subcommand's requirement.txt file avoids Sphinx 5.2.0.post0, which triggers a bug in sphinx-rtd-theme which happens to be the parent theme of the default theme sphinx_ansible_theme used by sphinx-init (#39, #40).

1.5.0

Release Summary

Feature and bugfix release.

Minor Changes

• Detect filter and test plugin aliases and avoid them being emitted multiple times. Instead insert redirects so that stub pages will be created (#33).
• Replace ansible.builtin with ansible-core, ansible-base, or Ansible in version added collection names. Also write <collection_name> <version> instead of <version> of <collection_name> (#34).

Bugfixes

• Fix escaping of collection names in version added statements, and fix collection names for roles options (#34).

1.4.0

Release Summary

Feature and bugfix release.

Minor Changes

• The sphinx-init subcommand now also creates an antsibull-docs.cfg file and moves configuration settings from CLI flags in build.sh to this configuration file (#26).
• There are two new options for explicitly specified configuration files named collection_url and collection_install. These allow to override the URLs pointing to collections (default link to galaxy.ansible.com), and the commands to install collections (use ansible-galaxy collection install by default). This can be useful when documenting (internal) collections that are not available on Ansible Galaxy. The default antsibull-docs.cfg generated by the sphinx-init subcommand shows how this can be configured (#15, #26).
• When generating plugin error pages, or showing non-fatal errors in plugins or roles, link to the collection's issue tracker instead of the collection's URL if available (#29).

Bugfixes

• Make handling of bad documentation more robust when certain values are None while the keys are present (#32).

1.3.0

Release Summary

Feature and bugfix release.

Minor Changes

• Ensure that values for default, choices, and sample use the types specified for the option / return value (#19).
• If a plugin or module has requirements listed, add a disclaimer next to the installation line at the top that further requirements are needed (#23, #24).
• Show the 'you might already have this collection installed if you are using the ansible package' disclaimer for plugins only for official docsite builds (subcommands devel and stable). Also include this disclaimer for roles on official docsite builds (#25).
• Use true and false for booleans instead of yes and no (ansible-community/community-topics#116, #19).
• When processing formatting directives, make sure to properly escape all other text for RST respectively HTML instead of including it verbatim (#21, #22).

Bugfixes

• Improve indentation of HTML blocks for tables to avoid edge cases which generate invalid RST (#22).

1.2.2

Release Summary

Bugfix release.

Bugfixes

• Fix rstcheck-core support (#20).

1.2.1

Release Summary

Bugfix release.

Bugfixes

• Do not escape <, >, &, and ' in JSONified defaults and examples as the Jinja2 tojson filter <https://jinja.palletsprojects.com/en/2.11.x/templates/#tojson>_ does. Also improve formatting by making sure , is followed by a space (#18).
• The collection filter was ignored when parsing the ansible-galaxy collection list output for the docs build (#16, #17).

1.2.0

Release Summary

Feature and bugfix release.

Minor Changes

• Support plugin seealso from the semantic markup specification <https://hackmd.io/VjN60QSoRSSeRfvGmOH1lQ?both>__ (#8).
• The lint-collection-docs subcommand has a new boolean flag --plugin-docs which renders the plugin docs to RST and validates them with rstcheck. This can be used as a lighter version of rendering the docsite in CI (#12).
• The files in the source repository now follow the REUSE Specification <https://reuse.software/spec/>_. The only exceptions are changelog fragments in changelogs/fragments/ (#14).

Bugfixes

• Make sure that _input does not show up twice for test or filter arguments when the plugin mentions it in positional (#10).
• Mark rstcheck 4.x and 5.x as compatible. Support rstcheck 6.x as well (#13).

1.1.0

Release Summary

Feature release with support for ansible-core 2.14's sidecar docs feature.

Minor Changes

• If lookup plugins have a single return value starting with _, that return value is now labelled Return value (#6).
• If lookup plugins have an option called _terms, it is now shown in its own section Terms, and not in the regular Parameters section (#6).
• More robust handling of parsing errors when ansible-doc was unable to extract documentation (#6).
• Support parameter type any, and show raw as any (#6).
• Support test and filter plugins when ansible-core 2.14+ is used. This works with the current devel branch of ansible-core (#6).

1.0.1

Release Summary

Bugfix release.

Bugfixes

• Make sure that aliases of module/plugin options and return values that result in identical RST labels under docutil's normalization are only emitted once (#7).
• Properly escape module/plugin option and return value slugs in generated HTML (#7).

1.0.0

Release Summary

First stable release.

Major Changes

• From version 1.0.0 on, antsibull-docs is sticking to semantic versioning and aims at providing no backwards compatibility breaking changes to the command line API (antsibull-docs) during a major release cycle. We explicitly exclude code compatibility. antsibull-docs is not supposed to be used as a library, and when used as a library it might not conform to semantic versioning (#2).

Minor Changes

• Only mention 'These are the collections with docs hosted on docs.ansible.com' for stable and devel subcommands (#3).
• Stop using some API from antsibull-core that is being removed (#1).