2.1.0

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

2.0.0

Release Summary

Major new release that drops support for older Python and Ansible/ansible-base/ansible-core versions.

Major Changes

• Change pyproject build backend from poetry-core to hatchling. pip install antsibull-docs works exactly the same as before, but some users may be affected depending on how they build/install the project (#115).

Minor Changes

• Allow to use the currently installed ansible-core version for the devel and stable subcommands (#121).
• Ansibull-docs now no longer depends directly on sh (#122).
• Bump version range of antsibull-docs requirement written by sphinx-init subcommand to >= 2.0.0, < 3.0.0. Previously, this was set to >=2.0.0a2, <3.0.0 (#151).
• Now depends antsibull-core 2.0.0 or newer; antsibull-core 1.x.y is no longer supported (#122).
• Remove residual compatability code for Python 3.6 and 3.7 (https://github.com/ansible-community/antsibull-docs/pulls/70).
• Support a per-collection docs config file docs/docsite/config.yml. It is also linted by the lint-collection-docs subcommand (#134).
• The antsibull-docs requirement in the requirements.txt file created by the sphinx-init subcommand now has version range >= 2.0.0, < 3.0.0 (#126).
• The dependency antsibull-docs-parser <https://github.com/ansible-community/antsibull-docs-parser>__ has been added and is used for processing Ansible markup (#124).

Breaking Changes / Porting Guide

• Disable flatmapping for all collections except community.general < 6.0.0 and community.network < 5.0.0. You can enable flatmapping for your collection by setting flatmap: true in docs/docsite/config.yml (#134).
• Drop support for Python 3.6, 3.7, and 3.8 (#115)."
• No longer removes PYTHONPATH from the environment when calling ansible, ansible-galaxy, or ansible-doc outside a self-created venv (#121).
• No longer supports Ansible 2.9, ansible-base 2.10, and ansible-core 2.11 and 2.12. The minimum required ansible-core version is 2.13. This allows for simpler and more efficient docs parsing and information retrieval (#120).
• The ansible-doc and ansible-internal values for doc_parsing_backend in the configuration file have been removed. Change the value to auto for best compatibility (#120).

Bugfixes

• Bump version range of antsibull-docs requirement written by sphinx-init subcommand to >= 2.0.0a2, < 3.0.0. Previously, this was set to >=2.0.0, <3.0.0 which could not be satisfied (#149).
• Use doc_parsing_backend from the application context instead of the library context. This prevents removal of doc_parsing_backend from the antsibull-core library context (#125).

2.0.0a2

Release Summary

Hotfix to make sphinx-init work properly.

Bugfixes

• Bump version range of antsibull-docs requirement written by sphinx-init subcommand to >= 2.0.0a2, < 3.0.0. Previously, this was set to >=2.0.0, <3.0.0 which could not be satisfied (#149).

2.0.0a1

Release Summary

Pre-release of new major 2.0.0 release.

Major Changes

• Change pyproject build backend from poetry-core to hatchling. pip install antsibull-docs works exactly the same as before, but some users may be affected depending on how they build/install the project (#115).

Minor Changes

• Allow to use the currently installed ansible-core version for the devel and stable subcommands (#121).
• Ansibull-docs now no longer depends directly on sh (#122).
• Now depends antsibull-core 2.0.0 or newer; antsibull-core 1.x.y is no longer supported (#122).
• Remove residual compatability code for Python 3.6 and 3.7 (https://github.com/ansible-community/antsibull-docs/pulls/70).
• Support a per-collection docs config file docs/docsite/config.yml. It is also linted by the lint-collection-docs subcommand (#134).
• The antsibull-docs requirement in the requirements.txt file created by the sphinx-init subcommand now has version range >= 2.0.0, < 3.0.0 (#126).
• The dependency antsibull-docs-parser <https://github.com/ansible-community/antsibull-docs-parser>__ has been added and is used for processing Ansible markup (#124).

Breaking Changes / Porting Guide

• Disable flatmapping for all collections except community.general < 6.0.0 and community.network < 5.0.0. You can enable flatmapping for your collection by setting flatmap: true in docs/docsite/config.yml (#134).
• Drop support for Python 3.6, 3.7, and 3.8 (#115)."
• No longer removes PYTHONPATH from the environment when calling ansible, ansible-galaxy, or ansible-doc outside a self-created venv (#121).
• No longer supports Ansible 2.9, ansible-base 2.10, and ansible-core 2.11 and 2.12. The minimum required ansible-core version is 2.13. This allows for simpler and more efficient docs parsing and information retrieval (#120).
• The ansible-doc and ansible-internal values for doc_parsing_backend in the configuration file have been removed. Change the value to auto for best compatibility (#120).

Bugfixes

• Use doc_parsing_backend from the application context instead of the library context. This prevents removal of doc_parsing_backend from the antsibull-core library context (#125).

1.11.0

Release Summary

Feature release.

Minor Changes

• Add support for semantic markup in roles (#113).
• Internal refactoring of markup code (#108).
• The lint-collection-docs subcommand can be told not to run rstcheck when --plugin-docs is used by passing --skip-rstcheck. This speeds up testing for large collections (#112).
• The lint-collection-docs subcommand will now also validate Ansible markup when --plugin-docs is passed. It can also ensure that no semantic markup is used with the new --disallow-semantic-markup option. This can for example be used by collections to avoid semantic markup being backported to older stable branches (#112).

1.10.0

Release Summary

Bugfix and feature release.

Major Changes

• Support new semantic markup in documentation (#4).

Minor Changes

• Add a note about the ordering of positional and named parameter to the plugin page. Also mention positional and keyword parameters for lookups (#101).
• Update schema for roles argument spec to allow specifying attributes on the entrypoint level. These are now also rendered when present (#103).

Bugfixes

• Explicitly declare the sh dependency and limit it to before 2.0.0. Also explicitly declare the dependencies on pydantic, semantic_version, aiohttp, twiggy, and PyYAML (#99).
• Restrict the pydantic dependency to major version 1 (#102).

1.9.0

Release Summary

Feature release.

Minor Changes

• Improve build script generated by antsibull-docs sphinx-init to change to the directory where the script is located, instead of hardcoding the script's path. This also fixed the existing bug that the path was not quoted (#91, #92).
• Show callback plugin type on callback plugin pages. Also write callback indexes by callback plugin type (#89, #90).

1.8.2

Release Summary

Bugfix release.

Bugfixes

• Fix the new options --extra-html-context and --extra-html-theme-options of the sphinx-init subcommand (#86).

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