docs: fix docs session (#1950)

When the `summary_overview.md` file was added, various `nox -s docs` sessions were complaining as it's not included in any of the toc trees. Since warnings are treated as errors, it fails the builds. Adding this as a hidden toctree allows the warning to be suppressed, as well as have no effect to the current documentation. Verified that the docs session passes with https://togithub.com/googleapis/python-storage/pull/1252, and then verified locally that docfx sessions are not affected with this change.
googleapis · Apr 7, 2024 · 223f39e · 223f39e
1 parent d7c2271
commit 223f39e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/synthtool/gcp/templates/python_library/docs/index.rst b/synthtool/gcp/templates/python_library/docs/index.rst
@@ -35,3 +35,9 @@ For a list of all ``{{ metadata['repo']['distribution_name'] }}`` releases:
     :maxdepth: 2
 
     changelog
+{% if is_google_cloud_api %}
+.. toctree::
+  :hidden:
+
+  summary_overview.md
+{% endif -%}
diff --git a/synthtool/gcp/templates/python_mono_repo_library/docs/index.rst b/synthtool/gcp/templates/python_mono_repo_library/docs/index.rst
@@ -35,3 +35,9 @@ For a list of all ``{{ metadata['repo']['distribution_name'] }}`` releases:
     :maxdepth: 2
 
     CHANGELOG
+{% if is_google_cloud_api %}
+.. toctree::
+  :hidden:
+
+  summary_overview.md
+{% endif -%}