Add error handling.

src/antsibull_docs/cli/doc_commands/plugin.py

@@ -70,7 +70,7 @@ def generate_plugin_docs(
         )
     except CalledProcessError as exc:
         err_msg = []
-        formatted_exception = traceback.format_exception(None, exc, exc.__traceback__)
+        formatted_exception = traceback.format_exception(exc)
         err_msg.append(
             f"Exception while parsing documentation for {plugin_type} plugin:"
             f" {plugin_name}.  Will not document this plugin."

src/antsibull_docs/write_docs/changelog.py

@@ -46,31 +46,39 @@ async def write_changelog(
     flog = mlog.fields(func="write_changelog")
     flog.debug("Enter")
 
-    paths = PathsConfig.force_collection(collection_metadata.path)
-
-    collection_details = CollectionDetails(paths)
-    collection_details.namespace, collection_details.name = collection_name.split(
-        ".", 1
-    )
-    collection_details.version = collection_metadata.version
-    collection_details.flatmap = collection_metadata.docs_config.flatmap
-
-    config = ChangelogConfig.default(paths, collection_details)
-    config.title = collection_name.title()
-    config.use_fqcn = True
-    config.mention_ancestor = True
-    config.flatmap = collection_metadata.docs_config.flatmap
-
-    changes = load_changes(config)
-
-    generator = ChangelogGenerator(config, changes)
-
-    renderer = create_document_renderer(output_format.changelog_format)
-    generator.generate(renderer)
-
-    changelog_contents = renderer.render()
-    for warning in renderer.get_warnings():
-        flog.warning(warning)
+    try:
+        paths = PathsConfig.force_collection(collection_metadata.path)
+
+        collection_details = CollectionDetails(paths)
+        collection_details.namespace, collection_details.name = collection_name.split(
+            ".", 1
+        )
+        collection_details.version = collection_metadata.version
+        collection_details.flatmap = collection_metadata.docs_config.flatmap
+
+        config = ChangelogConfig.default(paths, collection_details)
+        config.title = collection_name.title()
+        config.use_fqcn = True
+        config.mention_ancestor = True
+        config.flatmap = collection_metadata.docs_config.flatmap
+
+        changes = load_changes(config)
+
+        generator = ChangelogGenerator(config, changes)
+
+        renderer = create_document_renderer(output_format.changelog_format)
+        generator.generate(renderer)
+
+        changelog_contents = renderer.render()
+        for warning in renderer.get_warnings():
+            flog.warning(warning)
+    except Exception as exc:  # pylint: disable=broad-exception-caught
+        flog.warning(f"Error while processing changelog for {collection_name}: {exc}")
+        changelog_contents = f"""
+The changelog of {collection_name} could not be rendered::
+
+  {exc}
+"""
 
     changelog_file = os.path.join(
         collection_dir, f"changelog{output_format.output_extension}"

tests/functional/baseline-default/collections/ns2/col/changelog.rst

@@ -0,0 +1,4 @@
+
+The changelog of ns2.col could not be rendered::
+
+  list index out of range

tests/functional/baseline-default/collections/ns2/col/index.rst

@@ -66,6 +66,13 @@ Communication
 .. toctree::
     :maxdepth: 1
 
+Changelog
+---------
+
+.. toctree::
+    :maxdepth: 1
+
+    changelog
 
 Guides
 ------

tests/functional/baseline-no-breadcrumbs/collections/ns2/col/changelog.rst

@@ -0,0 +1,4 @@
+
+The changelog of ns2.col could not be rendered::
+
+  list index out of range

tests/functional/baseline-no-breadcrumbs/collections/ns2/col/index.rst

@@ -67,6 +67,13 @@ Communication
 .. toctree::
     :maxdepth: 1
 
+Changelog
+---------
+
+.. toctree::
+    :maxdepth: 1
+
+    changelog
 
 Guides
 ------

tests/functional/baseline-no-indexes/collections/ns2/col/changelog.rst

@@ -0,0 +1,4 @@
+
+The changelog of ns2.col could not be rendered::
+
+  list index out of range

tests/functional/baseline-no-indexes/collections/ns2/col/index.rst

@@ -66,6 +66,13 @@ Communication
 .. toctree::
     :maxdepth: 1
 
+Changelog
+---------
+
+.. toctree::
+    :maxdepth: 1
+
+    changelog
 
 Guides
 ------

tests/functional/baseline-simplified-rst-squash-hierarchy/changelog.rst

@@ -0,0 +1,4 @@
+
+The changelog of ns2.col could not be rendered::
+
+  list index out of range

tests/functional/baseline-simplified-rst-squash-hierarchy/index.rst

@@ -46,6 +46,10 @@ Communication
 - Mailing list: `Ansible Project List <https://groups.google.com/g/ansible-project>`__.
   (`Subscribe <mailto:[email protected]?subject=subscribe>`__)
 
+Changelog
+---------
+
+`Ns2.Col Release Notes <changelog.rst>`_
 
 Guides
 ------

tests/functional/baseline-simplified-rst/collections/ns2/col/changelog.rst

@@ -0,0 +1,4 @@
+
+The changelog of ns2.col could not be rendered::
+
+  list index out of range

tests/functional/baseline-simplified-rst/collections/ns2/col/index.rst

@@ -46,6 +46,10 @@ Communication
 - Mailing list: `Ansible Project List <https://groups.google.com/g/ansible-project>`__.
   (`Subscribe <mailto:[email protected]?subject=subscribe>`__)
 
+Changelog
+---------
+
+`Ns2.Col Release Notes <changelog.rst>`_
 
 Guides
 ------

tests/functional/baseline-squash-hierarchy/changelog.rst

@@ -0,0 +1,4 @@
+
+The changelog of ns2.col could not be rendered::
+
+  list index out of range

tests/functional/baseline-squash-hierarchy/index.rst

@@ -66,6 +66,13 @@ Communication
 .. toctree::
     :maxdepth: 1
 
+Changelog
+---------
+
+.. toctree::
+    :maxdepth: 1
+
+    changelog
 
 Guides
 ------

tests/functional/baseline-use-html-blobs/collections/ns2/col/changelog.rst

@@ -0,0 +1,4 @@
+
+The changelog of ns2.col could not be rendered::
+
+  list index out of range

tests/functional/baseline-use-html-blobs/collections/ns2/col/index.rst

@@ -66,6 +66,13 @@ Communication
 .. toctree::
     :maxdepth: 1
 
+Changelog
+---------
+
+.. toctree::
+    :maxdepth: 1
+
+    changelog
 
 Guides
 ------

tests/functional/collections/ansible_collections/ns2/col/changelogs/changelog.yaml

@@ -0,0 +1,8 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+releases:
+  - 1
+  - 2

tests/functional/collections/ansible_collections/ns2/col/docs/docsite/config.yml

@@ -6,3 +6,6 @@
 envvar_directives:
   - FOOBAR1
   - FOOBAR2
+
+changelog:
+  write_changelog: true