diff --git a/packages/google-cloud-translate/docs/README.rst b/packages/google-cloud-translate/docs/README.rst new file mode 120000 index 000000000000..89a0106941ff --- /dev/null +++ b/packages/google-cloud-translate/docs/README.rst @@ -0,0 +1 @@ +../README.rst \ No newline at end of file diff --git a/packages/google-cloud-translate/docs/gapic/v3beta1/api.rst b/packages/google-cloud-translate/docs/gapic/v3beta1/api.rst new file mode 100644 index 000000000000..4d46ad1362b4 --- /dev/null +++ b/packages/google-cloud-translate/docs/gapic/v3beta1/api.rst @@ -0,0 +1,6 @@ +Client for Cloud Translation API +================================ + +.. automodule:: google.cloud.translate_v3beta1 + :members: + :inherited-members: \ No newline at end of file diff --git a/packages/google-cloud-translate/docs/gapic/v3beta1/types.rst b/packages/google-cloud-translate/docs/gapic/v3beta1/types.rst new file mode 100644 index 000000000000..8b9725da3b1d --- /dev/null +++ b/packages/google-cloud-translate/docs/gapic/v3beta1/types.rst @@ -0,0 +1,5 @@ +Types for Cloud Translation API Client +====================================== + +.. automodule:: google.cloud.translate_v3beta1.types + :members: \ No newline at end of file diff --git a/packages/google-cloud-translate/docs/index.rst b/packages/google-cloud-translate/docs/index.rst index ba85ec9fe05f..8b370cfdae11 100644 --- a/packages/google-cloud-translate/docs/index.rst +++ b/packages/google-cloud-translate/docs/index.rst @@ -1,4 +1,4 @@ -.. include:: /../translate/README.rst +.. include:: README.rst Detailed Usage Guide -------------------- @@ -9,11 +9,25 @@ Detailed Usage Guide API Reference ------------- + +A new beta release, spelled ``v3beta1``, is provided to provide for preview +of upcoming features. In order to use this, you will want to import from +``google.cloud.translate_v3beta1`` in lieu of ``google.cloud.translate``. + +.. toctree:: + :maxdepth: 2 + + gapic/v3beta1/api + gapic/v3beta1/types + +An API and type reference is provided for v2: + .. toctree:: :maxdepth: 2 client + Changelog --------- diff --git a/packages/google-cloud-translate/google/cloud/translate_v3beta1/proto/translation_service_pb2.py b/packages/google-cloud-translate/google/cloud/translate_v3beta1/proto/translation_service_pb2.py index d25701491f05..249c9ed50821 100644 --- a/packages/google-cloud-translate/google/cloud/translate_v3beta1/proto/translation_service_pb2.py +++ b/packages/google-cloud-translate/google/cloud/translate_v3beta1/proto/translation_service_pb2.py @@ -2913,8 +2913,8 @@ generate at most 2 \* n output files. (n is the # of target\_language\_codes in the BatchTranslateTextRequest). Output files (tsv) generated are compliant with RFC 4180 - except that record delimiters are ':raw-latex:`\n`' instead of - ':raw-latex:`\r`:raw-latex:`\n`'. We don't provide any way to + except that record delimiters are ``\\\\n`` instead of + ``\\\\r\\\\n``. We don't provide any way to change record delimiters. While the input files are being processed, we write/update an index file 'index.csv' under 'output\_uri\_prefix' (for example, gs://translation- diff --git a/packages/google-cloud-translate/noxfile.py b/packages/google-cloud-translate/noxfile.py index fad9b6cc11b5..755db8e2ec41 100644 --- a/packages/google-cloud-translate/noxfile.py +++ b/packages/google-cloud-translate/noxfile.py @@ -16,6 +16,7 @@ from __future__ import absolute_import import os +import shutil import nox @@ -138,3 +139,22 @@ def cover(session): session.run("coverage", "report", "--show-missing", "--fail-under=100") session.run("coverage", "erase") + +@nox.session(python='3.6') +def docs(session): + """Build the docs.""" + + session.install('sphinx', 'alabaster', 'recommonmark') + session.install('-e', '.') + + shutil.rmtree(os.path.join('docs', '_build'), ignore_errors=True) + session.run( + 'sphinx-build', + '-W', # warnings as errors + '-T', # show full traceback on exception + '-N', # no colors + '-b', 'html', + '-d', os.path.join('docs', '_build', 'doctrees', ''), + os.path.join('docs', ''), + os.path.join('docs', '_build', 'html', ''), + ) diff --git a/packages/google-cloud-translate/synth.metadata b/packages/google-cloud-translate/synth.metadata index 0ea210bea1b4..d4194a55308a 100644 --- a/packages/google-cloud-translate/synth.metadata +++ b/packages/google-cloud-translate/synth.metadata @@ -1,19 +1,19 @@ { - "updateTime": "2019-04-04T12:25:29.184680Z", + "updateTime": "2019-04-08T22:42:12.391231Z", "sources": [ { "generator": { "name": "artman", - "version": "0.16.23", - "dockerImage": "googleapis/artman@sha256:f3a3f88000dc1cd1b4826104c5574aa5c534f6793fbf66e888d11c0d7ef5762e" + "version": "0.16.25", + "dockerImage": "googleapis/artman@sha256:d9597f983d1d4e61272c63cb97b7d8f8234da9999526c35d357de3d781f0ec1b" } }, { "git": { - "name": "googleapis-private", - "remote": "https://github.com/googleapis/googleapis-private.git", - "sha": "6c972ee69c6f4e4ae19df06c4c2a082cee64cab0", - "internalRef": "241798897" + "name": "googleapis", + "remote": "git@github.com:googleapis/googleapis.git", + "sha": "9a02c5acecb43f38fae4fa52c6420f21c335b888", + "internalRef": "242170119" } }, { @@ -27,7 +27,7 @@ "destinations": [ { "client": { - "source": "googleapis-private", + "source": "googleapis", "apiName": "translate", "apiVersion": "v3beta1", "language": "python", diff --git a/packages/google-cloud-translate/synth.py b/packages/google-cloud-translate/synth.py index bbbaf64c178c..553d4a9d7479 100644 --- a/packages/google-cloud-translate/synth.py +++ b/packages/google-cloud-translate/synth.py @@ -32,12 +32,12 @@ "translate", version, include_protos=True, - private=True, ) #s.move(library / f'google/cloud/translation_{version}', f'google/cloud/translate_{version}', excludes=excludes) s.move(library / f'google/cloud/translate_{version}', excludes=excludes) s.move(library / 'tests') + s.move(library / f"docs/gapic/{version}") # translation -> translate s.replace( @@ -46,6 +46,12 @@ "google.cloud.translate_v3beta1.proto", ) +s.replace( + "google/cloud/**/translation_service_pb2.py", + r"""record delimiters are ':raw-latex:`\\n`' instead of + ':raw-latex:`\\r`:raw-latex:`\\n`'.""", + r"""record delimiters are ``\\\\\\\\n`` instead of + ``\\\\\\\\r\\\\\\\\n``.""",) # ---------------------------------------------------------------------------- # Add templated files # ----------------------------------------------------------------------------