Antsibull

Latest version: v0.67.0

Safety actively analyzes 685525 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 21

2.15.0

=======

Release Summary
---------------

Bugfix and feature release which migrates to Pydantic 2.

Minor Changes
-------------

- Migrated all models to Pydantic 2. This is mostly transparent, except that validation error messages slightly change, and that some validation is more strict. For example, if a boolean is used instead of a string, say in a description, this now results in an error instead of a silent coercion. Numbers are still accepted for strings (for example ``version_added`` with float values like ``2.14``) (https://github.com/ansible-community/antsibull-docs/pull/331, https://github.com/ansible-community/antsibull-core/pull/333, https://github.com/ansible-community/antsibull-core/pull/344).
- This project now depends on antsibull-core >= 3.2.0 and pydantic 2 (https://github.com/ansible-community/antsibull-docs/pull/330).
- Use Proxy configuration settings from the environment. Check out the `aiohttp documentation on Proxy support <https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support>`__ for information on which environment variables are supported (https://github.com/ansible/ansible-documentation/issues/1936, https://github.com/ansible-community/antsibull-docs/pull/346).
- Use language ``ini`` for example INI code blocks (https://github.com/ansible-community/antsibull-docs/pull/335).
- When rendering the Ansible docsite with the ``stable`` and ``devel`` subcommands, information on deprecated collections is shown (https://github.com/ansible-community/ansible-build-data/pull/450, https://github.com/ansible-community/antsibull-docs/pull/330).
- When rendering the Ansible docsite with the ``stable`` and ``devel`` subcommands, stub pages for removed collections are added (https://github.com/ansible-community/ansible-build-data/pull/459, https://github.com/ansible-community/antsibull-docs/pull/341).

2.14.0

=======

Release Summary
---------------

Feature release.

Minor Changes
-------------

- Add dependency on antsibull-fileutils. Some functionality from antsibull-core is moving there, so we can use it from there directly (https://github.com/ansible-community/antsibull-docs/pull/322).
- Add deprecation markers next to module/plugin/role descriptions in lists (https://github.com/ansible-community/antsibull-docs/issues/141, https://github.com/ansible-community/antsibull-docs/pull/320).
- Remove ansible-project Google Groups mailing list from ansible.builtin links (https://github.com/ansible-community/antsibull-docs/pull/325).

2.13.1

=======

Release Summary
---------------

Bugfix release.

Bugfixes
--------

- The output filename used by the ``plugin`` subcommand contained two dots before the ``rst`` extension (https://github.com/ansible-community/antsibull-docs/issues/317, https://github.com/ansible-community/antsibull-docs/pull/318).

2.13.0

=======

Release Summary
---------------

Bugfix and feature release.

Minor Changes
-------------

- Allow to disable adding the antsibull-docs version to the generated files with the ``--no-add-antsibull-docs-version`` command line flag, or the ``add_antsibull_docs_version = false`` setting in the antsibull-docs config file (https://github.com/ansible-community/antsibull-docs/issues/304, https://github.com/ansible-community/antsibull-docs/pull/308).
- Bump minimal required version of dependency antsibull-docs-parser to 1.1.0 This allows to use a new whitespace-removal feature (https://github.com/ansible-community/antsibull-docs/pull/312).
- If you are using `argcomplete <https://pypi.org/project/argcomplete/>`__, you can now tab-complete ``antsibull-docs`` command lines. See `Activating global completion <https://pypi.org/project/argcomplete/#activating-global-completion>`__ in the argcomplete README for how to enable tab completion globally. This will also tab-complete Ansible commands such as ``ansible-playbook`` and ``ansible-test`` (https://github.com/ansible-community/antsibull-docs/pull/302).
- Most documentation generating subcommands now have a ``--cleanup`` parameter which allows to delete files and directories that were not created by antsibull-docs in the destination directory (https://github.com/ansible-community/antsibull-docs/pull/315).
- No longer use ``rsync`` when creating a build script with the ``sphinx-init`` subcommand (https://github.com/ansible-community/antsibull-docs/pull/315).
- Remove superfluous whitespace or escaped spaces from templates (https://github.com/ansible-community/antsibull-docs/pull/313).
- Remove trailing whitespace and leading and trailing empty lines from rendered templates, and ensure they end with a newline if not empty (https://github.com/ansible-community/antsibull-docs/pull/314).

Bugfixes
--------

- Fix RST escaping of the title in the collections per namespace list. This causes a space to vanish between namespace name and the word ``Namespace`` with newer versions of antsibull-docs-parser (https://github.com/ansible-community/antsibull-docs/pull/311).

2.12.0

=======

Release Summary
---------------

Bugfix and feature release.

Minor Changes
-------------

- Allow to mention forums in the Communication section of collection links (https://github.com/ansible-community/antsibull-docs/pull/288).
- Bump minimum dependency of ``antsibull-docs-parser`` to 1.0.2 or newer (https://github.com/ansible-community/antsibull-docs/pull/290).
- The ``lint-collection-docs`` subcommand will now complain about unchanged default values in ``docs/docsite/links.yml`` taken from the `community collection template <https://github.com/ansible-collections/collection_template/>`__ (https://github.com/ansible-community/antsibull-docs/issues/273, https://github.com/ansible-community/antsibull-docs/pull/277).
- The collection docs linter now reports empty markup, like ``I()``, ``L(,https://example.com)`` (https://github.com/ansible-community/antsibull-docs/pull/292).

Bugfixes
--------

- Improve handling of empty markup parameters for RST (https://github.com/ansible-community/antsibull-docs/pull/290).
- Improve rendering of empty or broken changelogs (https://github.com/ansible-community/antsibull-docs/pull/289).
- Remove leading spaces in paragraphs to avoid unintended RST blockquotes (https://github.com/ansible-community/antsibull-docs/pull/289).
- Render errors as code blocks of language ``text`` instead of using the default lexer (https://github.com/ansible-community/antsibull-docs/pull/289).

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

Page 1 of 21

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.