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

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