search

googleapis / synthtool

Apache License 2.0
88 stars 84 forks source link

build(python): fix `docs` and `docfx` builds #1916

Closed parthea closed 9 months ago

parthea commented 9 months ago

This PR fixes the docs and docfx builds which recently started failing as described in https://github.com/googleapis/sphinx-docfx-yaml/issues/344

As an example, see the failure in PR https://github.com/googleapis/google-cloud-python/pull/12198 here.

This PR fixes the issue below

Running Sphinx v4.5.0

Traceback (most recent call last):
  File "/home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-config/.nox/docs/lib/python3.10/site-packages/sphinx/registry.py", line 438, in load_extension
    metadata = setup(app)
  File "/home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-config/.nox/docs/lib/python3.10/site-packages/sphinxcontrib/applehelp/__init__.py", line 230, in setup
    app.require_sphinx('5.0')
  File "/home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-config/.nox/docs/lib/python3.10/site-packages/sphinx/application.py", line 393, in require_sphinx
    raise VersionRequirementError(version)
sphinx.errors.VersionRequirementError: 5.0

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-config/.nox/docs/lib/python3.10/site-packages/sphinx/cmd/build.py", line 272, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-config/.nox/docs/lib/python3.10/site-packages/sphinx/application.py", line 219, in __init__
    self.setup_extension(extension)
  File "/home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-config/.nox/docs/lib/python3.10/site-packages/sphinx/application.py", line 380, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/runner/work/google-cloud-python/google-cloud-python/packages/google-cloud-config/.nox/docs/lib/python3.10/site-packages/sphinx/registry.py", line 441, in load_extension
    raise VersionRequirementError(
sphinx.errors.VersionRequirementError: The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.