diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b13deb4..7481571e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,151 +2,174 @@ **Topics** -- v2\.10\.0 +- v2\.11\.0 - Release Summary - Minor Changes - Bugfixes -- v2\.9\.0 +- v2\.10\.0 - Release Summary - Minor Changes -- v2\.8\.0 + - Bugfixes +- v2\.9\.0 - Release Summary - Minor Changes - - Bugfixes -- v2\.7\.0 +- v2\.8\.0 - Release Summary - Minor Changes - Bugfixes -- v2\.6\.1 +- v2\.7\.0 - Release Summary + - Minor Changes - Bugfixes -- v2\.6\.0 +- v2\.6\.1 - Release Summary - - Minor Changes - Bugfixes -- v2\.5\.0 +- v2\.6\.0 - Release Summary - Minor Changes -- v2\.4\.0 + - Bugfixes +- v2\.5\.0 - Release Summary - Minor Changes +- v2\.4\.0 + - Release Summary + - Minor Changes - Deprecated Features - - Bugfixes + - Bugfixes - Known Issues - v2\.3\.1 - - Release Summary - - Bugfixes -- v2\.3\.0 - Release Summary - - Minor Changes - Bugfixes -- v2\.2\.0 +- v2\.3\.0 - Release Summary - Minor Changes - Bugfixes -- v2\.1\.0 +- v2\.2\.0 - Release Summary - Minor Changes - Bugfixes -- v2\.0\.0 +- v2\.1\.0 - Release Summary - - Major Changes - Minor Changes - - Breaking Changes / Porting Guide - Bugfixes -- v1\.11\.0 +- v2\.0\.0 - Release Summary + - Major Changes - Minor Changes -- v1\.10\.0 + - Breaking Changes / Porting Guide + - Bugfixes +- v1\.11\.0 - Release Summary - - Major Changes - Minor Changes - - Bugfixes -- v1\.9\.0 +- v1\.10\.0 - Release Summary + - Major Changes - Minor Changes -- v1\.8\.2 - - Release Summary - Bugfixes -- v1\.8\.1 +- v1\.9\.0 + - Release Summary + - Minor Changes +- v1\.8\.2 - Release Summary - Bugfixes -- v1\.8\.0 +- v1\.8\.1 - Release Summary - - Minor Changes - Bugfixes -- v1\.7\.4 +- v1\.8\.0 - Release Summary + - Minor Changes - Bugfixes -- v1\.7\.3 +- v1\.7\.4 - Release Summary - Bugfixes -- v1\.7\.2 +- v1\.7\.3 - Release Summary - Bugfixes -- v1\.7\.1 +- v1\.7\.2 - Release Summary - Bugfixes -- v1\.7\.0 +- v1\.7\.1 - Release Summary - - Minor Changes - Bugfixes -- v1\.6\.1 +- v1\.7\.0 - Release Summary + - Minor Changes - Bugfixes -- v1\.6\.0 +- v1\.6\.1 - Release Summary - - Minor Changes - Bugfixes -- v1\.5\.0 +- v1\.6\.0 - Release Summary - Minor Changes - Bugfixes -- v1\.4\.0 +- v1\.5\.0 - Release Summary - Minor Changes - Bugfixes -- v1\.3\.0 +- v1\.4\.0 - Release Summary - Minor Changes - Bugfixes -- v1\.2\.2 +- v1\.3\.0 - Release Summary + - Minor Changes - Bugfixes -- v1\.2\.1 +- v1\.2\.2 - Release Summary - Bugfixes -- v1\.2\.0 +- v1\.2\.1 - Release Summary - - Minor Changes - Bugfixes -- v1\.1\.0 +- v1\.2\.0 - Release Summary - Minor Changes -- v1\.0\.1 - - Release Summary - Bugfixes -- v1\.0\.0 +- v1\.1\.0 + - Release Summary + - Minor Changes +- v1\.0\.1 - Release Summary + - Bugfixes +- v1\.0\.0 + - Release Summary - Major Changes - - Minor Changes + - Minor Changes - v0\.1\.0 - - Release Summary + - Release Summary + + +## v2\.11\.0 + + +### Release Summary + +Feature and bugfix release\. + + +### Minor Changes + +* Support examples for role entrypoints \([https\://github\.com/ansible\-community/antsibull\-docs/pull/244](https\://github\.com/ansible\-community/antsibull\-docs/pull/244)\)\. + + +### Bugfixes + +* Fix handling of choices that are dictionaries for type\=list \([https\://github\.com/ansible\-community/antsibull\-docs/pull/276](https\://github\.com/ansible\-community/antsibull\-docs/pull/276)\)\. +* Fix handling of default for type\=list if choices is present \([https\://github\.com/ansible\-community/antsibull\-docs/pull/276](https\://github\.com/ansible\-community/antsibull\-docs/pull/276)\)\. ## v2\.10\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * It is now possible to render the collection changelog as part of the collection docsite by using the changelog option in docs/docsite/config\.yml \([https\://github\.com/ansible\-community/antsibull\-docs/issues/31](https\://github\.com/ansible\-community/antsibull\-docs/issues/31)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/267](https\://github\.com/ansible\-community/antsibull\-docs/pull/267)\)\. - + ### Bugfixes * Fix internal links to options and return values in simplified RST output \([https\://github\.com/ansible\-community/antsibull\-docs/pull/269](https\://github\.com/ansible\-community/antsibull\-docs/pull/269)\)\. @@ -155,12 +178,12 @@ Bugfix and feature release\. ## v2\.9\.0 - + ### Release Summary Maintenance release\. - + ### Minor Changes * Add support for the antsibull\-core v3 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/261](https\://github\.com/ansible\-community/antsibull\-docs/pull/261)\)\. @@ -168,12 +191,12 @@ Maintenance release\. ## v2\.8\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * Add support for \"dark mode\" to the option table styling \([https\://github\.com/ansible\-community/antsibull\-docs/pull/253](https\://github\.com/ansible\-community/antsibull\-docs/pull/253)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/258](https\://github\.com/ansible\-community/antsibull\-docs/pull/258)\)\. @@ -181,7 +204,7 @@ Bugfix and feature release\. * Declare support for Python 3\.12 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/255](https\://github\.com/ansible\-community/antsibull\-docs/pull/255)\)\. * The colors used by the CSS provided by the Antsibull Sphinx extension can now be overridden \([https\://github\.com/ansible\-community/antsibull\-docs/pull/254](https\://github\.com/ansible\-community/antsibull\-docs/pull/254)\)\. - + ### Bugfixes * Fix duplicate docs detection \(for aliases\) for latest ansible\-core devel \([https\://github\.com/ansible\-community/antsibull\-docs/pull/257](https\://github\.com/ansible\-community/antsibull\-docs/pull/257)\)\. @@ -189,17 +212,17 @@ Bugfix and feature release\. ## v2\.7\.0 - + ### Release Summary Bugfix and refactoring release\. - + ### Minor Changes * Explicitly set up Galaxy context instead of relying on deprecated functionality \([https\://github\.com/ansible\-community/antsibull\-docs/pull/234](https\://github\.com/ansible\-community/antsibull\-docs/pull/234)\)\. - + ### Bugfixes * Fix schema for seealso in role entrypoints\. Plugin references now work \([https\://github\.com/ansible\-community/antsibull\-docs/issues/237](https\://github\.com/ansible\-community/antsibull\-docs/issues/237)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/240](https\://github\.com/ansible\-community/antsibull\-docs/pull/240)\)\. @@ -210,12 +233,12 @@ Bugfix and refactoring release\. ## v2\.6\.1 - + ### Release Summary Bugfix release\. - + ### Bugfixes * For role argument specs\, allow author\, description\, and todo to be a string instead of a list of strings\, similarly as with ansible\-doc and with modules and plugins \([https\://github\.com/ansible\-community/antsibull\-docs/pull/227](https\://github\.com/ansible\-community/antsibull\-docs/pull/227)\)\. @@ -224,17 +247,17 @@ Bugfix release\. ## v2\.6\.0 - + ### Release Summary Fix parsing of EXAMPLES and improve error message - + ### Minor Changes * Improve error messages when calls to ansible\-doc fail \([https\://github\.com/ansible\-community/antsibull\-docs/pull/223](https\://github\.com/ansible\-community/antsibull\-docs/pull/223)\)\. - + ### Bugfixes * When EXAMPLES has the format specified by \# fmt\: \\, this value is used to determine the code block type \([https\://github\.com/ansible\-community/antsibull\-docs/pull/225](https\://github\.com/ansible\-community/antsibull\-docs/pull/225)\)\. @@ -242,12 +265,12 @@ Fix parsing of EXAMPLES and improve error message ## v2\.5\.0 - + ### Release Summary Release to support the updated Ansible Galaxy codebase\. - + ### Minor Changes * The default collection URL template has been changed from https\://galaxy\.ansible\.com/\{namespace\}/\{name\} to https\://galaxy\.ansible\.com/ui/repo/published/\{namespace\}/\{name\}/ to adjust for the Galaxy codebase change on September 30th\, 2023 \([https\://github\.com/ansible\-community/antsibull\-docs/issues/147](https\://github\.com/ansible\-community/antsibull\-docs/issues/147)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/220](https\://github\.com/ansible\-community/antsibull\-docs/pull/220)\)\. @@ -255,7 +278,7 @@ Release to support the updated Ansible Galaxy codebase\. ## v2\.4\.0 - + ### Release Summary Bugfix and feature release\. Improves support for other builders than html\. @@ -264,7 +287,7 @@ There will be a follow\-up release after [Ansible Galaxy](https\://galaxy\.ansib switched to the new galaxy\_ng codebase\, which is scheduled for September 30th\. That release will only adjust the URLs to Galaxy\, except potentially bugfixes\. - + ### Minor Changes * Add basic support for other HTML based Sphinx builders such as epub and singlehtml \([https\://github\.com/ansible\-community/antsibull\-docs/pull/201](https\://github\.com/ansible\-community/antsibull\-docs/pull/201)\)\. @@ -288,7 +311,7 @@ That release will only adjust the URLs to Galaxy\, except potentially bugfixes\. * The \-\-use\-html\-blobs feature that inserts HTML blobs for the options and return value tables for the ansible\-docsite output format is deprecated and will be removed soon\. The HTML tables cause several features to break\, such as references to options and return values\. If you think this feature needs to stay\, please create an issue in the [antsibull\-docs repository](https\://github\.com/ansible\-community/antsibull\-docs/issues/) and provide good reasons for it \([https\://github\.com/ansible\-community/antsibull\-docs/pull/217](https\://github\.com/ansible\-community/antsibull\-docs/pull/217)\)\. - + ### Bugfixes * Document and ensure that the collection subcommand with \-\-use\-current can only be used with collection names \([https\://github\.com/ansible\-community/antsibull\-docs/pull/214](https\://github\.com/ansible\-community/antsibull\-docs/pull/214)\)\. @@ -307,12 +330,12 @@ That release will only adjust the URLs to Galaxy\, except potentially bugfixes\. ## v2\.3\.1 - + ### Release Summary Bugfix release with a CSS fix for the Sphinx extension\. - + ### Bugfixes * Fix antsibull Sphinx extension CSS so that the option/return value anchors for module/plugin/role documentation can also be used on WebKit\-based browsers such as Gnome Web and Safari \([https\://github\.com/ansible\-community/antsibull\-docs/issues/188](https\://github\.com/ansible\-community/antsibull\-docs/issues/188)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/189](https\://github\.com/ansible\-community/antsibull\-docs/pull/189)\)\. @@ -320,12 +343,12 @@ Bugfix release with a CSS fix for the Sphinx extension\. ## v2\.3\.0 - + ### 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 \ syntax similar to the \:ref\: role \([https\://github\.com/ansible\-community/antsibull\-docs/pull/180](https\://github\.com/ansible\-community/antsibull\-docs/pull/180)\)\. @@ -335,7 +358,7 @@ Bugfix and feature release\. * Use Dart sass compiler instead of sassc to compile CSS for Sphinx extension \([https\://github\.com/ansible\-community/antsibull\-docs/issues/185](https\://github\.com/ansible\-community/antsibull\-docs/issues/185)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/186](https\://github\.com/ansible\-community/antsibull\-docs/pull/186)\)\. * When parsing errors happen in the Sphinx extension\, the extension now emits error messages during the build process in addition to error markup \([https\://github\.com/ansible\-community/antsibull\-docs/pull/187](https\://github\.com/ansible\-community/antsibull\-docs/pull/187)\)\. - + ### Bugfixes * Consider module/plugin aliases when linting references to other modules and plugins \([https\://github\.com/ansible\-community/antsibull\-docs/pull/184](https\://github\.com/ansible\-community/antsibull\-docs/pull/184)\)\. @@ -345,18 +368,18 @@ Bugfix and feature release\. ## v2\.2\.0 - + ### Release Summary Bugfix and feature release improving rendering and linting\. - + ### Minor Changes * Collection docs linter \- also validate seealso module and plugin destinations \([https\://github\.com/ansible\-community/antsibull\-docs/issues/168](https\://github\.com/ansible\-community/antsibull\-docs/issues/168)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/171](https\://github\.com/ansible\-community/antsibull\-docs/pull/171)\)\. * When linting collection plugin docs\, make sure that array stubs \[\.\.\.\] are used when referencing sub\-options or sub\-return values inside lists\, and are not used outside lists and dictionaries \([https\://github\.com/ansible\-community/antsibull\-docs/pull/173](https\://github\.com/ansible\-community/antsibull\-docs/pull/173)\)\. - + ### Bugfixes * Fix the way the Sphinx extension creates nodes for options and return values so they look identical for internal references\, external \(intersphinx\) references\, and unresolved references \([https\://github\.com/ansible\-community/antsibull\-docs/pull/175](https\://github\.com/ansible\-community/antsibull\-docs/pull/175)\)\. @@ -367,12 +390,12 @@ Bugfix and feature release improving rendering and linting\. ## v2\.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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/157](https\://github\.com/ansible\-community/antsibull\-docs/pull/157)\)\. @@ -384,7 +407,7 @@ Feature and bugfix release with many improvements related to semantic markup and * When linting semantic markup in collection docs\, also accept aliases when checking O\(\) values \([https\://github\.com/ansible\-community/antsibull\-docs/pull/155](https\://github\.com/ansible\-community/antsibull\-docs/pull/155)\)\. * When refering to markup in multi\-paragraph texts\, like description\, now includes the paragraph number in error messages \([https\://github\.com/ansible\-community/antsibull\-docs/pull/163](https\://github\.com/ansible\-community/antsibull\-docs/pull/163)\)\. - + ### Bugfixes * Allow role entrypoint deprecations without having to specify the collection the role is removed from \([https\://github\.com/ansible\-community/antsibull\-docs/pull/156](https\://github\.com/ansible\-community/antsibull\-docs/pull/156)\)\. @@ -394,7 +417,7 @@ Feature and bugfix release with many improvements related to semantic markup and ## v2\.0\.0 - + ### Release Summary Major new release that drops support for older Python and Ansible/ansible\-base/ansible\-core versions\. @@ -404,7 +427,7 @@ Major new release that drops support for older Python and Ansible/ansible\-base/ * 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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/115](https\://github\.com/ansible\-community/antsibull\-docs/pull/115)\)\. - + ### Minor Changes * Allow to use the currently installed ansible\-core version for the devel and stable subcommands \([https\://github\.com/ansible\-community/antsibull\-docs/pull/121](https\://github\.com/ansible\-community/antsibull\-docs/pull/121)\)\. @@ -425,7 +448,7 @@ Major new release that drops support for older Python and Ansible/ansible\-base/ * 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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/120](https\://github\.com/ansible\-community/antsibull\-docs/pull/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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/120](https\://github\.com/ansible\-community/antsibull\-docs/pull/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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/149](https\://github\.com/ansible\-community/antsibull\-docs/pull/149)\)\. @@ -434,12 +457,12 @@ Major new release that drops support for older Python and Ansible/ansible\-base/ ## v1\.11\.0 - + ### Release Summary Feature release\. - + ### Minor Changes * Add support for semantic markup in roles \([https\://github\.com/ansible\-community/antsibull\-docs/pull/113](https\://github\.com/ansible\-community/antsibull\-docs/pull/113)\)\. @@ -450,7 +473,7 @@ Feature release\. ## v1\.10\.0 - + ### Release Summary Bugfix and feature release\. @@ -460,13 +483,13 @@ Bugfix and feature release\. * Support new semantic markup in documentation \([https\://github\.com/ansible\-community/antsibull\-docs/pull/4](https\://github\.com/ansible\-community/antsibull\-docs/pull/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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/101](https\://github\.com/ansible\-community/antsibull\-docs/pull/101)\)\. * Update schema for roles argument spec to allow specifying attributes on the entrypoint level\. These are now also rendered when present \([https\://github\.com/ansible\-community/antsibull\-docs/pull/103](https\://github\.com/ansible\-community/antsibull\-docs/pull/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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/99](https\://github\.com/ansible\-community/antsibull\-docs/pull/99)\)\. @@ -475,12 +498,12 @@ Bugfix and feature release\. ## v1\.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 \([https\://github\.com/ansible\-community/antsibull\-docs/issues/91](https\://github\.com/ansible\-community/antsibull\-docs/issues/91)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/92](https\://github\.com/ansible\-community/antsibull\-docs/pull/92)\)\. @@ -489,12 +512,12 @@ Feature release\. ## v1\.8\.2 - + ### Release Summary Bugfix release\. - + ### Bugfixes * Fix the new options \-\-extra\-html\-context and \-\-extra\-html\-theme\-options of the sphinx\-init subcommand \([https\://github\.com/ansible\-community/antsibull\-docs/pull/86](https\://github\.com/ansible\-community/antsibull\-docs/pull/86)\)\. @@ -502,12 +525,12 @@ Bugfix release\. ## v1\.8\.1 - + ### Release Summary Bugfix release\. - + ### Bugfixes * When creating toctrees for breadcrumbs\, place subtree for a plugin type in the plugin type\'s section \([https\://github\.com/ansible\-community/antsibull\-docs/pull/83](https\://github\.com/ansible\-community/antsibull\-docs/pull/83)\)\. @@ -515,12 +538,12 @@ Bugfix release\. ## v1\.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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/77](https\://github\.com/ansible\-community/antsibull\-docs/pull/77)\)\. @@ -532,7 +555,7 @@ Feature and bugfix release\. * The default index\.rst created by antsibull\-docs sphinx\-init includes the new environment variable index \([https\://github\.com/ansible\-community/antsibull\-docs/pull/80](https\://github\.com/ansible\-community/antsibull\-docs/pull/80)\)\. * Use correct markup \(envvar role\) for environment variables\. Compile an index of all environment variables used by plugins \([https\://github\.com/ansible\-community/antsibull\-docs/pull/73](https\://github\.com/ansible\-community/antsibull\-docs/pull/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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/79](https\://github\.com/ansible\-community/antsibull\-docs/pull/79)\)\. @@ -540,12 +563,12 @@ Feature and bugfix release\. ## v1\.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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/69](https\://github\.com/ansible\-community/antsibull\-docs/pull/69)\)\. @@ -555,12 +578,12 @@ Bugfix release\. ## v1\.7\.3 - + ### Release Summary Bugfix release\. - + ### Bugfixes * Fix rendering of the action\_group attribute \([https\://github\.com/ansible\-community/antsibull\-docs/pull/62](https\://github\.com/ansible\-community/antsibull\-docs/pull/62)\)\. @@ -568,12 +591,12 @@ Bugfix release\. ## v1\.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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/61](https\://github\.com/ansible\-community/antsibull\-docs/pull/61)\)\. @@ -581,12 +604,12 @@ Bugfix release\. ## v1\.7\.1 - + ### Release Summary Bugfix release\. - + ### Bugfixes * Prevent crash during stable docsite build when \_python entry is present in deps file \([https\://github\.com/ansible\-community/antsibull\-docs/pull/57](https\://github\.com/ansible\-community/antsibull\-docs/pull/57)\)\. @@ -594,12 +617,12 @@ Bugfix release\. ## v1\.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 \([https\://github\.com/ansible\-community/antsibull\-docs/issues/35](https\://github\.com/ansible\-community/antsibull\-docs/issues/35)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/44](https\://github\.com/ansible\-community/antsibull\-docs/pull/44)\)\. @@ -610,7 +633,7 @@ Bugfix and feature release\. * 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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/50](https\://github\.com/ansible\-community/antsibull\-docs/pull/50)\)\. * Use code formatting for all values\, such as choice entries\, defaults\, and samples \([https\://github\.com/ansible\-community/antsibull\-docs/issues/38](https\://github\.com/ansible\-community/antsibull\-docs/issues/38)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/42](https\://github\.com/ansible\-community/antsibull\-docs/pull/42)\)\. - + ### Bugfixes * Avoid long aliases list to make left column too wide \([https\://github\.com/ansible\-collections/amazon\.aws/issues/1101](https\://github\.com/ansible\-collections/amazon\.aws/issues/1101)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/54](https\://github\.com/ansible\-community/antsibull\-docs/pull/54)\)\. @@ -619,12 +642,12 @@ Bugfix and feature release\. ## v1\.6\.1 - + ### Release Summary Bugfix release for ansible\-core 2\.14\. - + ### Bugfixes * Fix formulation of top\-level version\_added \([https\://github\.com/ansible\-community/antsibull\-docs/pull/43](https\://github\.com/ansible\-community/antsibull\-docs/pull/43)\)\. @@ -632,19 +655,19 @@ Bugfix release for ansible\-core 2\.14\. ## v1\.6\.0 - + ### Release Summary Bugfix and feature release\. - + ### Minor Changes * Allow to specify choices as dictionary instead of list \([https\://github\.com/ansible\-community/antsibull\-docs/pull/36](https\://github\.com/ansible\-community/antsibull\-docs/pull/36)\)\. * Use JSON serializer to format choices \([https\://github\.com/ansible\-community/antsibull\-docs/pull/37](https\://github\.com/ansible\-community/antsibull\-docs/pull/37)\)\. * Use special serializer to format INI values in examples \([https\://github\.com/ansible\-community/antsibull\-docs/pull/37](https\://github\.com/ansible\-community/antsibull\-docs/pull/37)\)\. - + ### Bugfixes * Avoid collection names with \_ in them appear wrongly escaped in the HTML output \([https\://github\.com/ansible\-community/antsibull\-docs/pull/41](https\://github\.com/ansible\-community/antsibull\-docs/pull/41)\)\. @@ -655,18 +678,18 @@ Bugfix and feature release\. ## v1\.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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/33](https\://github\.com/ansible\-community/antsibull\-docs/pull/33)\)\. * Replace ansible\.builtin with ansible\-core\, ansible\-base\, or Ansible in version added collection names\. Also write \ \ instead of \ of \ \([https\://github\.com/ansible\-community/antsibull\-docs/pull/34](https\://github\.com/ansible\-community/antsibull\-docs/pull/34)\)\. - + ### Bugfixes * Fix escaping of collection names in version added statements\, and fix collection names for roles options \([https\://github\.com/ansible\-community/antsibull\-docs/pull/34](https\://github\.com/ansible\-community/antsibull\-docs/pull/34)\)\. @@ -674,19 +697,19 @@ Feature and bugfix release\. ## v1\.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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/26](https\://github\.com/ansible\-community/antsibull\-docs/pull/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 \([https\://github\.com/ansible\-community/antsibull\-docs/issues/15](https\://github\.com/ansible\-community/antsibull\-docs/issues/15)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/26](https\://github\.com/ansible\-community/antsibull\-docs/pull/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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/29](https\://github\.com/ansible\-community/antsibull\-docs/pull/29)\)\. - + ### Bugfixes * Make handling of bad documentation more robust when certain values are None while the keys are present \([https\://github\.com/ansible\-community/antsibull\-docs/pull/32](https\://github\.com/ansible\-community/antsibull\-docs/pull/32)\)\. @@ -694,12 +717,12 @@ Feature and bugfix release\. ## v1\.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 \([https\://github\.com/ansible\-community/antsibull\-docs/pull/19](https\://github\.com/ansible\-community/antsibull\-docs/pull/19)\)\. @@ -708,7 +731,7 @@ Feature and bugfix release\. * Use true and false for booleans instead of yes and no \([https\://github\.com/ansible\-community/community\-topics/issues/116](https\://github\.com/ansible\-community/community\-topics/issues/116)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/19](https\://github\.com/ansible\-community/antsibull\-docs/pull/19)\)\. * When processing formatting directives\, make sure to properly escape all other text for RST respectively HTML instead of including it verbatim \([https\://github\.com/ansible\-community/antsibull\-docs/issues/21](https\://github\.com/ansible\-community/antsibull\-docs/issues/21)\, [https\://github\.com/ansible\-community/antsibull\-docs/pull/22](https\://github\.com/ansible\-community/antsibull\-docs/pull/22)\)\. - + ### Bugfixes * Improve indentation of HTML blocks for tables to avoid edge cases which generate invalid RST \([https\://github\.com/ansible\-community/antsibull\-docs/pull/22](https\://github\.com/ansible\-community/antsibull\-docs/pull/22)\)\. @@ -716,12 +739,12 @@ Feature and bugfix release\. ## v1\.2\.2 - + ### Release Summary Bugfix release\. - + ### Bugfixes * Fix rstcheck\-core support \([https\://github\.com/ansible\-community/antsibull\-docs/pull/20](https\://github\.com/ansible\-community/antsibull\-docs/pull/20)\)\. @@ -729,12 +752,12 @@ Bugfix release\. ## v1\.2\.1 - + ### Release Summary Bugfix release\. - + ### Bugfixes * Do not escape \<\, \>\, \&\, and \' in JSONified defaults and examples as the [Jinja2 tojson filter](https\://jinja\.palletsprojects\.com/en/2\.11\.x/templates/\#tojson) does\. Also improve formatting by making sure \, is followed by a space \([https\://github\.com/ansible\-community/antsibull\-docs/pull/18](https\://github\.com/ansible\-community/antsibull\-docs/pull/18)\)\. @@ -743,19 +766,19 @@ Bugfix release\. ## v1\.2\.0 - + ### Release Summary Feature and bugfix release\. - + ### Minor Changes * Support plugin seealso from the [semantic markup specification](https\://hackmd\.io/VjN60QSoRSSeRfvGmOH1lQ\?both) \([https\://github\.com/ansible\-community/antsibull\-docs/pull/8](https\://github\.com/ansible\-community/antsibull\-docs/pull/8)\)\. * The lint\-collection\-docs subcommand has a new boolean flag \-\-plugin\-docs which renders the plugin docs to RST and validates them with rstcheck\. This can be used as a lighter version of rendering the docsite in CI \([https\://github\.com/ansible\-community/antsibull\-docs/pull/12](https\://github\.com/ansible\-community/antsibull\-docs/pull/12)\)\. * The files in the source repository now follow the [REUSE Specification](https\://reuse\.software/spec/)\. The only exceptions are changelog fragments in changelogs/fragments/ \([https\://github\.com/ansible\-community/antsibull\-docs/pull/14](https\://github\.com/ansible\-community/antsibull\-docs/pull/14)\)\. - + ### Bugfixes * Make sure that \_input does not show up twice for test or filter arguments when the plugin mentions it in positional \([https\://github\.com/ansible\-community/antsibull\-docs/pull/10](https\://github\.com/ansible\-community/antsibull\-docs/pull/10)\)\. @@ -764,12 +787,12 @@ Feature and bugfix release\. ## v1\.1\.0 - + ### Release Summary Feature release with support for ansible\-core 2\.14\'s sidecar docs feature\. - + ### Minor Changes * If lookup plugins have a single return value starting with \_\, that return value is now labelled Return value \([https\://github\.com/ansible\-community/antsibull\-docs/pull/6](https\://github\.com/ansible\-community/antsibull\-docs/pull/6)\)\. @@ -781,12 +804,12 @@ Feature release with support for ansible\-core 2\.14\'s sidecar docs feature\. ## v1\.0\.1 - + ### Release Summary Bugfix release\. - + ### Bugfixes * Make sure that aliases of module/plugin options and return values that result in identical RST labels under docutil\'s normalization are only emitted once \([https\://github\.com/ansible\-community/antsibull\-docs/pull/7](https\://github\.com/ansible\-community/antsibull\-docs/pull/7)\)\. @@ -795,7 +818,7 @@ Bugfix release\. ## v1\.0\.0 - + ### Release Summary First stable release\. @@ -805,7 +828,7 @@ First stable release\. * From version 1\.0\.0 on\, antsibull\-docs is sticking to semantic versioning and aims at providing no backwards compatibility breaking changes to the command line API \(antsibull\-docs\) during a major release cycle\. We explicitly exclude code compatibility\. antsibull\-docs is not supposed to be used as a library\, and when used as a library it might not conform to semantic versioning \([https\://github\.com/ansible\-community/antsibull\-docs/pull/2](https\://github\.com/ansible\-community/antsibull\-docs/pull/2)\)\. - + ### Minor Changes * Only mention \'These are the collections with docs hosted on docs\.ansible\.com\' for stable and devel subcommands \([https\://github\.com/ansible\-community/antsibull\-docs/pull/3](https\://github\.com/ansible\-community/antsibull\-docs/pull/3)\)\. @@ -814,7 +837,7 @@ First stable release\. ## v0\.1\.0 - + ### Release Summary Initial release\. The antsibull\-docs tool is compatible to the one from antsibull 0\.43\.0\. diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 504571bd..a8af9e18 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,25 @@ antsibull-docs -- Ansible Documentation Build Scripts Release Notes .. contents:: Topics +v2.11.0 +======= + +Release Summary +--------------- + +Feature and bugfix release. + +Minor Changes +------------- + +- Support examples for role entrypoints (https://github.com/ansible-community/antsibull-docs/pull/244). + +Bugfixes +-------- + +- Fix handling of ``choices`` that are dictionaries for ``type=list`` (https://github.com/ansible-community/antsibull-docs/pull/276). +- Fix handling of ``default`` for ``type=list`` if ``choices`` is present (https://github.com/ansible-community/antsibull-docs/pull/276). + v2.10.0 ======= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 5cb0b854..28d36f47 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -539,6 +539,19 @@ releases: - 267-changelog.yml - 269-refs.yml release_date: '2024-04-15' + 2.11.0: + changes: + bugfixes: + - Fix handling of ``choices`` that are dictionaries for ``type=list`` (https://github.com/ansible-community/antsibull-docs/pull/276). + - Fix handling of ``default`` for ``type=list`` if ``choices`` is present (https://github.com/ansible-community/antsibull-docs/pull/276). + minor_changes: + - Support examples for role entrypoints (https://github.com/ansible-community/antsibull-docs/pull/244). + release_summary: Feature and bugfix release. + fragments: + - 2.11.0.yml + - 244-role-entrypoint-examples.yml + - 276-choices.yml + release_date: '2024-05-06' 2.2.0: changes: bugfixes: diff --git a/changelogs/fragments/2.11.0.yml b/changelogs/fragments/2.11.0.yml deleted file mode 100644 index 80287c3b..00000000 --- a/changelogs/fragments/2.11.0.yml +++ /dev/null @@ -1 +0,0 @@ -release_summary: Feature and bugfix release. diff --git a/changelogs/fragments/244-role-entrypoint-examples.yml b/changelogs/fragments/244-role-entrypoint-examples.yml deleted file mode 100644 index afe93380..00000000 --- a/changelogs/fragments/244-role-entrypoint-examples.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - "Support examples for role entrypoints (https://github.com/ansible-community/antsibull-docs/pull/244)." diff --git a/changelogs/fragments/276-choices.yml b/changelogs/fragments/276-choices.yml deleted file mode 100644 index 743e4853..00000000 --- a/changelogs/fragments/276-choices.yml +++ /dev/null @@ -1,3 +0,0 @@ -bugfixes: - - "Fix handling of ``choices`` that are dictionaries for ``type=list`` (https://github.com/ansible-community/antsibull-docs/pull/276)." - - "Fix handling of ``default`` for ``type=list`` if ``choices`` is present (https://github.com/ansible-community/antsibull-docs/pull/276)."