Skip to content

Commit 223f39e

Browse files
authored
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.
1 parent d7c2271 commit 223f39e

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

synthtool/gcp/templates/python_library/docs/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,9 @@ For a list of all ``{{ metadata['repo']['distribution_name'] }}`` releases:
3535
:maxdepth: 2
3636

3737
changelog
38+
{% if is_google_cloud_api %}
39+
.. toctree::
40+
:hidden:
41+
42+
summary_overview.md
43+
{% endif -%}

synthtool/gcp/templates/python_mono_repo_library/docs/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,9 @@ For a list of all ``{{ metadata['repo']['distribution_name'] }}`` releases:
3535
:maxdepth: 2
3636

3737
CHANGELOG
38+
{% if is_google_cloud_api %}
39+
.. toctree::
40+
:hidden:
41+
42+
summary_overview.md
43+
{% endif -%}

0 commit comments

Comments
 (0)