Skip to content

Commit

Permalink
docs: resurface googleapis.dev and prediction docs (#1724)
Browse files Browse the repository at this point in the history
I've mistakenly broken some of the docs for types links on googleapis.dev. Fixing the docs structure so the docs are showing again. If you run `nox -s docs` and take a look around the docs, they'll be back up.

I've verified that prediction pages are back up on c.g.c.

- [x] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/python-aiplatform/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)

Fixes #1722 🦕
  • Loading branch information
dandhlee authored Oct 17, 2022
1 parent 55e287f commit 24f0c6f
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 2 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
13 changes: 11 additions & 2 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,12 @@ def docs(session):
"""Build the docs for this library."""

session.install("-e", ".")
session.install("sphinx==4.0.1", "alabaster", "recommonmark")
session.install(
"sphinx==4.0.1",
"alabaster",
"google-cloud-aiplatform[prediction]",
"recommonmark",
)

shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
session.run(
Expand All @@ -302,7 +307,11 @@ def docfx(session):

session.install("-e", ".")
session.install(
"sphinx==4.0.1", "alabaster", "recommonmark", "gcp-sphinx-docfx-yaml"
"sphinx==4.0.1",
"alabaster",
"google-cloud-aiplatform[prediction]",
"recommonmark",
"gcp-sphinx-docfx-yaml",
)

shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True)
Expand Down
7 changes: 7 additions & 0 deletions owlbot.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,11 @@
# Don't include tests in calculation of test coverage
s.replace("noxfile.py", """ \"--cov=tests/unit\",""", "")

# Include prediction to be installed for documentation.
s.replace(
"noxfile.py",
"\"alabaster\"",
"\"alabaster\", \"google-cloud-aiplatform[prediction]\"",
)

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

0 comments on commit 24f0c6f

Please sign in to comment.