-
Notifications
You must be signed in to change notification settings - Fork 1.7k
chore: enable generation of google-cloud-dialogflow-cx #16724
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,16 @@ | ||
| { | ||
| "api_id": "dialogflow.googleapis.com", | ||
| "api_shortname": "dialogflow", | ||
| "client_documentation": "https://cloud.google.com/python/docs/reference/dialogflow-cx/latest", | ||
| "default_version": "v3", | ||
| "distribution_name": "google-cloud-dialogflow-cx", | ||
| "issue_tracker": "https://issuetracker.google.com/savedsearches/5300385", | ||
| "language": "python", | ||
| "library_type": "GAPIC_AUTO", | ||
| "name": "dialogflow-cx", | ||
| "name_pretty": "Dialogflow CX", | ||
| "product_documentation": "https://cloud.google.com/dialogflow/cx/docs", | ||
| "release_level": "stable", | ||
| "repo": "googleapis/google-cloud-python" | ||
| "api_description": "Builds conversational interfaces (for example, chatbots, and voice-powered\napps and devices).", | ||
| "api_id": "dialogflow.googleapis.com", | ||
| "api_shortname": "dialogflow", | ||
| "client_documentation": "https://cloud.google.com/python/docs/reference/dialogflow-cx/latest", | ||
| "default_version": "v3", | ||
| "distribution_name": "google-cloud-dialogflow-cx", | ||
| "issue_tracker": "https://issuetracker.google.com/savedsearches/5300385", | ||
| "language": "python", | ||
| "library_type": "GAPIC_AUTO", | ||
| "name": "dialogflow-cx", | ||
| "name_pretty": "Dialogflow CX", | ||
| "product_documentation": "https://cloud.google.com/dialogflow/cx/docs", | ||
| "release_level": "stable", | ||
| "repo": "googleapis/google-cloud-python" | ||
| } |
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -3,7 +3,8 @@ Python Client for Dialogflow CX | |||||||||||||
|
|
||||||||||||||
| |stable| |pypi| |versions| | ||||||||||||||
|
|
||||||||||||||
| `Dialogflow CX`_: | ||||||||||||||
| `Dialogflow CX`_: Builds conversational interfaces (for example, chatbots, and voice-powered | ||||||||||||||
| apps and devices). | ||||||||||||||
|
Comment on lines
+6
to
+7
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The hyperlink target definition for
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| - `Client Library Documentation`_ | ||||||||||||||
| - `Product Documentation`_ | ||||||||||||||
|
|
||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -390,7 +390,6 @@ def docs(session): | |||||||||||||
| shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) | ||||||||||||||
| session.run( | ||||||||||||||
| "sphinx-build", | ||||||||||||||
| "-W", # warnings as errors | ||||||||||||||
| "-T", # show full traceback on exception | ||||||||||||||
|
Comment on lines
392
to
393
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The -W flag (warnings as errors) was removed from the sphinx-build command. This flag is important for maintaining documentation quality by ensuring that any syntax errors or broken references are caught during the build process. It should be restored, especially since the changes in the README files appear to introduce documentation warnings.
Suggested change
References
|
||||||||||||||
| "-N", # no colors | ||||||||||||||
| "-b", | ||||||||||||||
|
|
||||||||||||||
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.
The hyperlink target definition for
Dialogflow CXis incorrectly formatted. In reStructuredText, the syntax`Name`_: TextexpectsTextto be a URL. Providing a description instead will break the link and likely cause a Sphinx warning. The description should be placed on a separate line, and the link should point to the product documentation.