Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs(bigquery): fix the broken docs#139

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

@HemangChothani
Copy link
Contributor

Fixes#138

-> I know conf.py file generated by synthtool ,this is temporary patch for bigquery.

-> new release of sphinx 3.1.1 Consider duplicate docstring ofAttributes: docstring andproperty docstring and raised an error of duplicate description so change the docstring fromAttributes: toArgs for more specific info refer this issue :sphinx-doc/sphinx#7817

@googlebotgooglebot added the cla: yesThis human has signed the Contributor License Agreement. labelJun 18, 2020
@HemangChothani
Copy link
ContributorAuthor

Opened a PR insynthtool to updateconf.py file templategoogleapis/synthtool#629

Copy link
Contributor

@plamutplamut left a comment

Choose a reason for hiding this comment

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

I know conf.py file generated by synthtool ,this is temporary patch for bigquery.

How about making the change insynth.py and change the key line indocs/conf.py file automatically?

The fix itself work, though, thanks for that!

@HemangChothani
Copy link
ContributorAuthor

@plamut The PR of synthtoolgoogleapis/synthtool#629 has been merged so i will remove the doc/conf.py change from here, but i don't have an idea about change in synth.py file.

@plamut
Copy link
Contributor

plamut commentedJun 19, 2020
edited
Loading

@HemangChothani I presume we still need to add the"inherited-members": True option to the docs config, because the synth template contains just the"members": True option? Re-generating the files withsynthtool erases that latter part, thus we need to add it manually (through a replacement configured insynth.py)

Mentioning this, because running the synthtool produces the following change (among others):

diff --git docs/conf.py docs/conf.pyindex 30dcac5..91b39ac 100644--- docs/conf.py+++ docs/conf.py@@ -43,7 +43,7 @@ extensions = [  # autodoc/autosummary flags autoclass_content = "both"-autodoc_default_options = {"members": True, "inherited-members": True}+autodoc_default_options = {"members": True} autosummary_generate = True

Or do you think we could actually make that change in thedocs/conf.py template itself? (don't know if that's suitable for all Python client libs, though)

autodoc_default_options = {"members": True, "inherited-members": True}

@HemangChothani
Copy link
ContributorAuthor

@plamut
In synth.py file can we do that? I am not sure right now as i am struggling with synth config to local machine.

s.replace(
"docs/conf.py",
{"members": True},
{"members": True, "inherited-members": True}
)

I am not sure that it will work for all clients or not , i will test it.

@plamut
Copy link
Contributor

@HemangChothani Yes, each library can add custom modifications to the generated files in itssynth.py.

The snippet above is the right direction, just mind that the second argument is treated as a regular expression, thus regex special characters need to be escaped.

If you have trouble setting up synth locally, I can post a patch here myself to save time, as I already happen to have everything working locally.

HemangChothani reacted with thumbs up emoji

@HemangChothani
Copy link
ContributorAuthor

@plamut Thank you for the guidance and support, i am able to run locally an test it and push the code, could you please verify it?

Copy link
Contributor

@plamutplamut left a comment

Choose a reason for hiding this comment

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

Regex pattern needs to be updated... if running the synthtool locally, doesn't it emit a warning that a replacement might no longer be needed?

Copy link
Contributor

@plamutplamut left a comment

Choose a reason for hiding this comment

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

Looks good now. The classes in the generated docs again have fully documented members, and re-generating the code preserves the relevant changes indocs/conf.py.

Thanks for adding the suggested improvements quickly!

HemangChothani reacted with thumbs up emoji
@HemangChothaniHemangChothani merged commit3235255 intogoogleapis:masterJun 19, 2020
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

1 more reviewer

@plamutplamutplamut approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cla: yesThis human has signed the Contributor License Agreement.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[docs][1.25] Documentation on https://googleapis.dev/python/bigquery/1.25.0/ is broken

3 participants

@HemangChothani@plamut@googlebot

[8]ページ先頭

©2009-2025 Movatter.jp