Release 2.13.0.

ansible-community · Aug 25, 2024 · 0db90a6 · 0db90a6
1 parent a78cfd4
commit 0db90a6
Show file tree

Hide file tree

Showing 12 changed files with 239 additions and 178 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,6 +4,30 @@ antsibull-docs -- Ansible Documentation Build Scripts Release Notes
 
 .. contents:: Topics
 
+v2.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).
+
 v2.12.0
 =======
 

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -859,3 +859,42 @@ releases:
       - 290-empty.yml
       - 292-linting-empty-markup.yml
     release_date: '2024-07-05'
+  2.13.0:
+    changes:
+      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).
+      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).
+      release_summary: Bugfix and feature release.
+    fragments:
+      - 2.13.0.yml
+      - 297-pyre.yml
+      - 302-argcomplete.yml
+      - 308-insert-version.yml
+      - 311-escaping.yml
+      - 312-parser-dep.yml
+      - 313-whitespace.yml
+      - 314-whitespace.yml
+      - 315-cleanup.yml
+    release_date: '2024-08-25'
diff --git a/changelogs/fragments/2.13.0.yml b/changelogs/fragments/2.13.0.yml
diff --git a/changelogs/fragments/297-pyre.yml b/changelogs/fragments/297-pyre.yml
diff --git a/changelogs/fragments/302-argcomplete.yml b/changelogs/fragments/302-argcomplete.yml
diff --git a/changelogs/fragments/308-insert-version.yml b/changelogs/fragments/308-insert-version.yml
diff --git a/changelogs/fragments/311-escaping.yml b/changelogs/fragments/311-escaping.yml
diff --git a/changelogs/fragments/312-parser-dep.yml b/changelogs/fragments/312-parser-dep.yml
diff --git a/changelogs/fragments/313-whitespace.yml b/changelogs/fragments/313-whitespace.yml
diff --git a/changelogs/fragments/314-whitespace.yml b/changelogs/fragments/314-whitespace.yml
diff --git a/changelogs/fragments/315-cleanup.yml b/changelogs/fragments/315-cleanup.yml