github ansible-community/antsibull-docs 2.3.0

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

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

Don't miss a new antsibull-docs release

NewReleases is sending notifications on new releases.