Skip to content
This repository was archived by the owner on Mar 6, 2026. It is now read-only.

chore: pin sphinx plugin version to working one - #715

Merged
jimfulton merged 1 commit into
masterfrom
dandhlee-patch-1
Jun 24, 2021
Merged

chore: pin sphinx plugin version to working one#715
jimfulton merged 1 commit into
masterfrom
dandhlee-patch-1

Conversation

@dandhlee

Copy link
Copy Markdown
Contributor

There's an issue with the current gcp-sphinx-docfx-yaml version failing for the following text:

 """Union[int, None]: Expiration time in milliseconds for a partition.
If :attr:`partition_expiration` is set and :attr:`type_` is
not set, :attr:`type_` will default to
:attr:`~google.cloud.bigquery.table.TimePartitioningType.DAY`.
"""

which gets converted to

Union[int, None]: Expiration time in milliseconds for a partition.
If <xref:partition_expiration> is set and <xref:type_> is
not set, <xref:type_> will default to
<xref:google.cloud.bigquery.table.TimePartitioningType.DAY>.

which fails on the plugin because it thinks <xref:type_> should be a token it needs to process. The docstring is not malformed, the plugin needs additional work.

I'll have a fix for this by the end of the day, but should you need to submit PRs then please merge this one to have yourself unblocked!

Unblocks #698 🦕

@dandhlee
dandhlee requested review from a team and stephaniewang526 and removed request for a teamJune 22, 2021 15:26
@product-auto-labelproduct-auto-labelBot added the api: bigquery Issues related to the googleapis/python-bigquery API. label Jun 22, 2021
@google-clagoogle-claBot added the cla: yes This human has signed the Contributor License Agreement. label Jun 22, 2021
@plamut

Copy link
Copy Markdown
Contributor

Thanks for this!

As mentioned in the chat, it's fine for now and we can wait for the proper fix. But if the latter gets significantly delayed for some reason, we'll use this one as a workaround.

@dandhlee

Copy link
Copy Markdown
ContributorAuthor

googleapis/sphinx-docfx-yaml#55 is ready for review, once that's submitted and released it should be good! Hopefully it won't take too long.

@jimfulton
jimfulton merged commit 5e9494e into masterJun 24, 2021
@jimfulton
jimfulton deleted the dandhlee-patch-1 branch June 24, 2021 12:08
dandhlee added a commit that referenced this pull request Jun 24, 2021
jimfulton pushed a commit that referenced this pull request Jun 24, 2021
emkornfield pushed a commit to emkornfield/python-bigquery that referenced this pull request Feb 11, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api: bigqueryIssues related to the googleapis/python-bigquery API.cla: yesThis human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@dandhlee@plamut@jimfulton