- Notifications
You must be signed in to change notification settings - Fork321
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
Uh oh!
There was an error while loading.Please reload this page.
Conversation
HemangChothani commentedJun 18, 2020
Opened a PR in |
plamut left a comment
There was a problem hiding this 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 commentedJun 19, 2020
@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 commentedJun 19, 2020 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
@HemangChothani I presume we still need to add the 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 the |
HemangChothani commentedJun 19, 2020
@plamut s.replace( I am not sure that it will work for all clients or not , i will test it. |
plamut commentedJun 19, 2020
@HemangChothani Yes, each library can add custom modifications to the generated files in its 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 commentedJun 19, 2020
@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? |
plamut left a comment
There was a problem hiding this 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?
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
plamut left a comment
There was a problem hiding this 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!
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 of
Attributes:docstring andpropertydocstring and raised an error of duplicate description so change the docstring fromAttributes:toArgsfor more specific info refer this issue :sphinx-doc/sphinx#7817