Skip to content
This repository has been archived by the owner on Dec 31, 2023. It is now read-only.

Commit

Permalink
docs: re-publish tables client documentation (#146)
Browse files Browse the repository at this point in the history
The tables client documentation got deleted on accident - this re-adds the `TablesClient` and `GcsClient` under `automl_v1beta1`. Verify locally by running `nox -s docs` and looking at the output in `docs/_build/html`.

Fixes b/184554120
  • Loading branch information
busunkim96 committed Apr 14, 2021
1 parent 20d0c28 commit 9f3e73a
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 23 deletions.
1 change: 1 addition & 0 deletions docs/automl_v1beta1/services.rst
Expand Up @@ -5,3 +5,4 @@ Services for Google Cloud Automl v1beta1 API

auto_ml
prediction_service
tables
11 changes: 11 additions & 0 deletions docs/automl_v1beta1/tables.rst
@@ -0,0 +1,11 @@
Tables
------------------------

.. automodule:: google.cloud.automl_v1beta1.services.tables.gcs_client
:members:
:inherited-members:


.. automodule:: google.cloud.automl_v1beta1.services.tables.tables_client
:members:
:inherited-members:
10 changes: 4 additions & 6 deletions noxfile.py
Expand Up @@ -188,8 +188,8 @@ def cover(session):
def docs(session):
"""Build the docs for this library."""

session.install("-e", ".[pandas,storage]")
session.install("sphinx<3.0.0", "alabaster", "recommonmark")
session.install("-e", ".")
session.install("sphinx", "alabaster", "recommonmark")

shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
session.run(
Expand All @@ -209,10 +209,8 @@ def docs(session):
def docfx(session):
"""Build the docfx yaml files for this library."""

session.install("-e", ".[pandas,storage]")
session.install(
"sphinx<3.0.0", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml"
)
session.install("-e", ".")
session.install("sphinx", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml")

shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
session.run(
Expand Down
22 changes: 5 additions & 17 deletions synth.py
Expand Up @@ -58,12 +58,11 @@

s.replace(
"docs/automl_v1beta1/services.rst",
"""(google\.cloud\.automl_v1beta1\.services\.prediction_service
:members:
:inherited-members:)""",
"""\g<1>\n.. automodule:: google.cloud.automl_v1beta1.services.tables
:members:
:inherited-members:"""
"""auto_ml
prediction_service""",
"""auto_ml
prediction_service
tables"""
)

# ----------------------------------------------------------------------------
Expand All @@ -79,9 +78,6 @@

s.move(templated_files)

# TODO(busunkim): Use latest sphinx after microgenerator transition
s.replace("noxfile.py", """['"]sphinx['"]""", '"sphinx<3.0.0"')
# TODO(busunkim): Remove after microgenerator transition.
# This is being added to AutoML because the proto comments are long and
# regex replaces are a brittle temporary solution.
s.replace(
Expand All @@ -90,12 +86,4 @@
\s+'-T', \# show full traceback on exception""",
""""-T", # show full traceback on exception""")


# install with extras (pandas, storage)
s.replace(
"noxfile.py",
"""session\.install\(['"]-e['"], ['"]\.['"]\)""",
"""session.install("-e", ".[pandas,storage]")""",
)

s.shell.run(["nox", "-s", "blacken"], hide_output=False)

0 comments on commit 9f3e73a

Please sign in to comment.