Description
Running the docs build in any of the generated golden clients fails.
See example below for the credentials client. I've confirmed that the issue is resolved if we upgrade sphinx.
See related issue #1713 for adding the docs build to presubmits.
(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==4.0.1 alabaster recommonmark
nox > sphinx-build -W -T -N -b html -d docs/_build/doctrees/ docs/ docs/_build/html/
Traceback (most recent call last):
File "/usr/local/google/home/partheniou/git/gapic-generator-python/tests/integration/goldens/credentials/.nox/docs/bin/sphinx-build", line 5, in <module>
from sphinx.cmd.build import main
File "/usr/local/google/home/partheniou/git/gapic-generator-python/tests/integration/goldens/credentials/.nox/docs/lib/python3.11/site-packages/sphinx/cmd/build.py", line 25, in <module>
from sphinx.application import Sphinx
File "/usr/local/google/home/partheniou/git/gapic-generator-python/tests/integration/goldens/credentials/.nox/docs/lib/python3.11/site-packages/sphinx/application.py", line 31, in <module>
from sphinx.config import Config
File "/usr/local/google/home/partheniou/git/gapic-generator-python/tests/integration/goldens/credentials/.nox/docs/lib/python3.11/site-packages/sphinx/config.py", line 21, in <module>
from sphinx.util import logging
File "/usr/local/google/home/partheniou/git/gapic-generator-python/tests/integration/goldens/credentials/.nox/docs/lib/python3.11/site-packages/sphinx/util/__init__.py", line 41, in <module>
from sphinx.util.typing import PathMatcher
File "/usr/local/google/home/partheniou/git/gapic-generator-python/tests/integration/goldens/credentials/.nox/docs/lib/python3.11/site-packages/sphinx/util/typing.py", line 37, in <module>
from types import Union as types_Union
ImportError: cannot import name 'Union' from 'types' (/usr/lib/python3.11/types.py)
nox > Command sphinx-build -W -T -N -b html -d docs/_build/doctrees/ docs/ docs/_build/html/ failed with exit code 1
nox > Session docs failed.