From 223f39e29577145d4238a522633c2f3e5e6dc8dc Mon Sep 17 00:00:00 2001 From: Dan Lee <71398022+dandhlee@users.noreply.github.com> Date: Sun, 7 Apr 2024 07:38:16 -0400 Subject: [PATCH] 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. --- synthtool/gcp/templates/python_library/docs/index.rst | 6 ++++++ .../gcp/templates/python_mono_repo_library/docs/index.rst | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/synthtool/gcp/templates/python_library/docs/index.rst b/synthtool/gcp/templates/python_library/docs/index.rst index 2a9454d41..e1aa6c7bb 100644 --- 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 index a6f86ae4c..dce5fc83b 100644 --- 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 -%}