1.8.1

Release Summary

Bugfix release.

Bugfixes

• When creating toctrees for breadcrumbs, place subtree for a plugin type in the plugin type's section (#83).

1.8.0

Release Summary

Feature and bugfix release.

Minor Changes

• Add new options --project, --copyright, --title, --html-short-title, --extra-conf, --extra-html-context, and --extra-html-theme-options to the sphinx-init subcommand to allow to customize the generated conf.py Sphinx configuration (#77).
• Automatically use a module's or plugin's short description as the "See also" description if no description is provided (#64, #74).
• It is now possible to provide a path to an existing file to be used as rst/index.rst for antsibull-docs sphinx-init (#68).
• Make compatible with antsibull-core 2.x.y (#78).
• Remove support for forced_action_plugin, a module attribute that was removed during the development phase of attributes (#63).
• Stop mentioning the version features were added for Ansible if the Ansible version is before 2.7 (#76).
• The default index.rst created by antsibull-docs sphinx-init includes the new environment variable index (#80).
• Use correct markup (envvar role) for environment variables. Compile an index of all environment variables used by plugins (#73).

Bugfixes

• Make sure that build.sh created by the sphinx-init subcommand sets proper permissions for antsibull-docs on the temp-rst directory it creates (#79).

1.7.4

Release Summary

Bugfix release.

Bugfixes

• Removed sphinx restriction in requirements.txt file created by antsibull-docs sphinx-init since the bug in sphinx-rtd-theme has been fixed (#69).
• The license header for the template for the rst/index.rst file created by antsibull-docs sphinx-init was commented incorrectly and thus showed up in the templated file (#67).
• When using --squash-hierarchy, do not mention the list of collections on the collection's index page (#72).

1.7.3

Release Summary

Bugfix release.

Bugfixes

• Fix rendering of the action_group attribute (#62).

1.7.2

Release Summary

Bugfix release.

Bugfixes

• Fix version_added processing for ansible.builtin 0.x to represent this as Ansible 0.x instead of ansible-core 0.x (#61).

1.7.1

Release Summary

Bugfix release.

Bugfixes

• Prevent crash during stable docsite build when _python entry is present in deps file (#57).

1.7.0

Release Summary

Bugfix and feature release.

Minor Changes

• Add --intersphinx option to the sphinx-init subcommand to allow adding additional intersphinx_mapping entries to conf.py (#35, #44).
• Allow the toctree entries for in a collection's docs/docsite/extra-docs.yml to be a dictionary with ref and title keys instead of just a reference as a string (#45).
• Antsibull-docs now depends on packaging <https://pypi.org/project/packaging/>__ (#49).
• The collection index pages now contain the supported versions of ansible-core of the collection in case collection's meta/runtime.yml specifies requires_ansible (#48, #49).
• The output of the lint-collection-docs command has been improved; in particular multi-line messages are now indented (#52).
• Use ansible --version to figure out ansible-core version when ansible-core is not installed for the same Python interpreter / venv that is used for antsibull-docs (#50).
• Use code formatting for all values, such as choice entries, defaults, and samples (#38, #42).

Bugfixes

• Avoid long aliases list to make left column too wide (ansible-collections/amazon.aws#1101, #54).
• Make lint-collection-docs --plugin-docs subcommand actually work (#47).

1.6.1

Release Summary

Bugfix release for ansible-core 2.14.

Bugfixes

• Fix formulation of top-level version_added (#43).

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