Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix docs session #1950

Merged
merged 2 commits into from
Apr 7, 2024
Merged

docs: fix docs session #1950

merged 2 commits into from
Apr 7, 2024

Conversation

dandhlee
Copy link
Contributor

@dandhlee dandhlee commented Apr 7, 2024

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 googleapis/python-storage#1252, and then verified locally that docfx sessions are not affected with this change.

@dandhlee dandhlee requested a review from parthea April 7, 2024 06:06
@dandhlee dandhlee marked this pull request as ready for review April 7, 2024 06:18
@dandhlee dandhlee requested review from a team and chingor13 as code owners April 7, 2024 06:18
@dandhlee dandhlee assigned parthea and unassigned chingor13 Apr 7, 2024
Copy link
Contributor

@parthea parthea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added suggestion to remove extra lines

@parthea parthea assigned dandhlee and unassigned parthea Apr 7, 2024
Copy link
Contributor Author

@dandhlee dandhlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Co-authored-by: Anthonios Partheniou <partheniou@google.com>
@dandhlee dandhlee added the automerge Merge the pull request once unit tests and other checks pass. label Apr 7, 2024
@gcf-merge-on-green gcf-merge-on-green bot merged commit 223f39e into master Apr 7, 2024
12 checks passed
@gcf-merge-on-green gcf-merge-on-green bot deleted the fix_docs_sessions branch April 7, 2024 11:38
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Apr 7, 2024
parthea added a commit to googleapis/python-spanner that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-storage that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-spanner that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* update replacement in owlbot.py

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-pubsublite that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-storage that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-runtimeconfig that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-pubsublite that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-runtimeconfig that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-pubsub that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-logging that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-bigquery that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-logging that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-bigquery that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Chalmer Lowe <chalmerlowe@google.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-firestore that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-firestore that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-bigquery-storage that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-bigquery-storage that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-cloud-core that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-cloud-core that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-dns that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-dns that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-documentai-toolbox that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-bigtable that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-datastore that referenced this pull request Apr 12, 2024
parthea added a commit to googleapis/python-bigtable that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-documentai-toolbox that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-datastore that referenced this pull request Apr 12, 2024
* chore(python): bump idna from 3.4 to 3.7 in .kokoro

Source-Link: googleapis/synthtool@d50980e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5a4c19d17e597b92d786e569be101e636c9c2817731f80a5adec56b2aa8fe070

* Apply changes from googleapis/synthtool#1950

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants