Skip to content
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

fix: fix docs build for generated clients #1715

Merged
merged 2 commits into from
Aug 3, 2023
Merged

fix: fix docs build for generated clients #1715

merged 2 commits into from
Aug 3, 2023

Conversation

parthea
Copy link
Contributor

@parthea parthea commented Aug 1, 2023

I've confirmed that the docs build now succeeds for generated clients with the changes in this PR:

(py39) partheniou@partheniou-vm-3:~/git/gapic-generator-python/tests/integration/goldens/credentials$ nox -s docs
/usr/local/google/home/partheniou/.pyenv/versions/py39/lib/python3.9/site-packages/setuptools/dist.py:945: SetuptoolsDeprecationWarning: The namespace_packages parameter is deprecated.
!!

        ********************************************************************************
        Please replace its usage with implicit namespaces (PEP 420).

        See https://setuptools.pypa.io/en/latest/references/keywords.html#keyword-namespace-packages for details.
        ********************************************************************************

!!
  ep.load()(self, ep.name, value)
nox > Running session docs
nox > Creating virtual environment (virtualenv) using python3.11 in .nox/docs
nox > python -m pip install -e .
nox > python -m pip install sphinx==7.0.1 alabaster recommonmark
nox > sphinx-build -W -T -N -b html -d docs/_build/doctrees/ docs/ docs/_build/html/
Running Sphinx v7.0.1
making output directory... done
[autosummary] generating autosummary for: credentials_v1/iam_credentials.rst, credentials_v1/services.rst, credentials_v1/types.rst, index.rst
loading intersphinx inventory from http://python.readthedocs.org/en/latest/objects.inv...
loading intersphinx inventory from https://gax-python.readthedocs.org/en/latest/objects.inv...
loading intersphinx inventory from https://google-auth.readthedocs.io/en/stable/objects.inv...
loading intersphinx inventory from https://gax-python.readthedocs.io/en/latest/objects.inv...
loading intersphinx inventory from https://googleapis.dev/python/google-api-core/latest/objects.inv...
loading intersphinx inventory from https://grpc.io/grpc/python/objects.inv...
loading intersphinx inventory from http://requests.kennethreitz.org/en/stable/objects.inv...
loading intersphinx inventory from https://proto-plus-python.readthedocs.io/en/stable/objects.inv...
loading intersphinx inventory from https://googleapis.dev/python/protobuf/latest/objects.inv...
intersphinx inventory has moved: http://requests.kennethreitz.org/en/stable/objects.inv -> https://requests.kennethreitz.org/en/stable/objects.inv
intersphinx inventory has moved: http://python.readthedocs.org/en/latest/objects.inv -> https://python.readthedocs.io/en/latest/objects.inv
intersphinx inventory has moved: https://grpc.io/grpc/python/objects.inv -> https://grpc.github.io/grpc/python/objects.inv
intersphinx inventory has moved: https://gax-python.readthedocs.org/en/latest/objects.inv -> https://gax-python.readthedocs.io/en/latest/objects.inv
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 4 source files that are out of date
updating environment: [new config] 4 added, 0 changed, 0 removed
reading sources... [ 25%] credentials_v1/iam_credentials
reading sources... [ 50%] credentials_v1/services
reading sources... [ 75%] credentials_v1/types
reading sources... [100%] index

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 25%] credentials_v1/iam_credentials
writing output... [ 50%] credentials_v1/services
writing output... [ 75%] credentials_v1/types
writing output... [100%] index

generating indices... genindex py-modindex done
highlighting module code... [ 33%] google.iam.credentials_v1.services.iam_credentials.async_client
highlighting module code... [ 66%] google.iam.credentials_v1.services.iam_credentials.client
highlighting module code... [100%] google.iam.credentials_v1.types.common

writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in docs/_build/html.
nox > Session docs was successful.

Fixes #1714 🦕

@parthea parthea requested a review from a team as a code owner August 1, 2023 16:56
@product-auto-label product-auto-label bot added the size: s Pull request size is small. label Aug 1, 2023
@ohmayr ohmayr self-requested a review August 3, 2023 17:15
Copy link
Contributor

@ohmayr ohmayr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified the changes locally and can confirm that this fixes docs build for generated clients.

@parthea parthea merged commit e4db994 into main Aug 3, 2023
51 checks passed
@parthea parthea deleted the fix-docs-build branch August 3, 2023 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: s Pull request size is small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs build for goldens failing
3 participants