github ansible-community/antsibull-docs 2.1.0

latest releases: 2.14.0, 2.13.1, 2.13.0...
15 months ago

Release Summary

Feature and bugfix release with many improvements related to semantic markup and validation.

Minor Changes

  • Add option --disallow-unknown-collection-refs to disallow references to other collections than the one covered by --validate-collection-refs (#157).
  • Add option --validate-collection-refs to the lint-collection-docs subcommand to also control which references to plugin/module/role names in (other) collections and their options and return values should be validated (#157).
  • Add the new collection config field envvar_directives which allows to declare which environment variables are declared with an .. envvar:: directive in the collection's extra docsite documentation. This is used, next to the plugin configuration information and the ansible-core configuration information, to determine whether an environment variable is referencable or not (#166).
  • Add the roles :ansenvvar: and :ansenvvarref: to the antsibull-docs Sphinx extension (#166).
  • Render E(...) markup with :ansenvvarref: or :ansenvvar: depending on whether the environment variable is known to be referencable or not (#166).
  • When linting markup in collection docs, validate plugin/module/role names, and also option/return value names for other plugins/modules/roles in the same collection, (transitively) dependent collections, and ansible.builtin (#157).
  • When linting semantic markup in collection docs, also accept aliases when checking O() values (#155).
  • When refering to markup in multi-paragraph texts, like description, now includes the paragraph number in error messages (#163).

Bugfixes

  • Allow role entrypoint deprecations without having to specify the collection the role is removed from (#156).
  • Indent module/plugin and role entrypoint deprecations correctly if 'Why' or 'Alternative' texts need more than one line (#156).
  • When collecting collection dependencies for the lint-collection-docs subcommand, a bug prevented the duplicate detection to work (#160).

Don't miss a new antsibull-docs release

NewReleases is sending notifications on new releases.