Skip to content

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

Merged
ohmayr merged 1 commit intomasterfrom
fix-docs-build
Jan 15, 2024
Merged

build(python): fix docs and docfx builds#1916
ohmayr merged 1 commit intomasterfrom
fix-docs-build

Conversation

@parthea
Copy link
Copy Markdown
Contributor

@parthea parthea commented Jan 13, 2024

This PR fixes the docs and docfx builds which recently started failing as described in googleapis/sphinx-docfx-yaml#344

As an example, see the failure in PR googleapis/google-cloud-python#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.

@parthea parthea requested a review from a team January 13, 2024 18:42
@parthea parthea requested a review from a team January 13, 2024 18:42
@parthea parthea mentioned this pull request Jan 15, 2024
Merged
@ohmayr ohmayr merged commit fac8444 into master Jan 15, 2024
@ohmayr ohmayr deleted the fix-docs-build branch January 15, 2024 15:49
@parthea parthea mentioned this pull request Jan 16, 2024
Merged
tswast added a commit to googleapis/python-bigquery-pandas that referenced this pull request Jan 16, 2024
@tswast
apply googleapis/synthtool#1916
c30efe4
cojenco added a commit to cojenco/python-storage that referenced this pull request Jan 16, 2024
@cojenco
apply googleapis/synthtool#1916
f7e53b9
cojenco added a commit to googleapis/python-storage that referenced this pull request Jan 16, 2024
@gcf-owl-bot @cojenco
build(python): fix docs and docfx builds (#1210)
a0416a2 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* apply googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Cathy Ouyang <cathyo@google.com>
tswast added a commit to googleapis/python-bigquery that referenced this pull request Jan 16, 2024
@tswast
manually sync googleapis/synthtool#1916
0b5b484
parthea added a commit to googleapis/google-cloud-python that referenced this pull request Jan 17, 2024
@parthea
build: fix docs and docfx builds (#12200)
8f0403c 
This PR updates the post processor image to the latest one which is
`gcr.io/cloud-devrel-public-resources/owlbot-python-mono-repo@sha256:1f42c1d6b70210540f55110662ae80e22b03dfb897782b09e546148599d3336c`.

The latest image fixes an issue with the docs and docfx builds. See
googleapis/synthtool#1916

Run the following commands to obtain the latest sha256
```
docker pull gcr.io/cloud-devrel-public-resources/owlbot-python-mono-repo:latest
```

```
docker inspect --format='{{.RepoDigests}}' gcr.io/cloud-devrel-public-resources/owlbot-python-mono-repo:latest
[gcr.io/cloud-devrel-public-resources/owlbot-python-mono-repo@sha256:1f42c1d6b70210540f55110662ae80e22b03dfb897782b09e546148599d3336c]
```
cojenco added a commit to googleapis/google-resumable-media-python that referenced this pull request Jan 17, 2024
@cojenco
apply googleapis/synthtool#1916
510d88e
cojenco added a commit to googleapis/google-resumable-media-python that referenced this pull request Jan 19, 2024
@gcf-owl-bot @cojenco
build(python): fix docs and docfx builds (#418)
d7b08b6 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* apply googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Cathy Ouyang <cathyo@google.com>
parthea added a commit to googleapis/python-org-policy that referenced this pull request Jan 22, 2024
@parthea
See googleapis/synthtool#1916
3b3dacc
parthea added a commit to googleapis/python-org-policy that referenced this pull request Jan 22, 2024
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#260)
73bfca5 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-grpc-google-iam-v1 that referenced this pull request Jan 22, 2024
@parthea
See googleapis/synthtool#1916
2ce8566
parthea added a commit to googleapis/python-grpc-google-iam-v1 that referenced this pull request Jan 22, 2024
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#78)
0974641 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-spanner-django that referenced this pull request Jan 22, 2024
@parthea
See googleapis/synthtool#1916
3058549
parthea added a commit to googleapis/python-access-context-manager that referenced this pull request Jan 22, 2024
@parthea
See googleapis/synthtool#1916
221e9cc
parthea added a commit to googleapis/python-access-context-manager that referenced this pull request Jan 22, 2024
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#195)
45cb84f 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-spanner-django that referenced this pull request Jan 22, 2024
@gcf-owl-bot @parthea
chore(deps): bump jinja2 from 3.1.2 to 3.1.3 in /.kokoro (#852)
884cdf0 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-cloud-core that referenced this pull request Jan 22, 2024
@parthea
See googleapis/synthtool#1916
f18354d
parthea added a commit to googleapis/python-cloud-core that referenced this pull request Jan 24, 2024
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#272)
9b8b68d 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

* See python/typeshed#11254

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-api-core that referenced this pull request Jan 25, 2024
@parthea
See googleapis/synthtool#1916
ec94b75
parthea added a commit to googleapis/python-api-core that referenced this pull request Jan 25, 2024
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#581)
ebc2635 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See python/typeshed#11254

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/proto-plus-python that referenced this pull request Jan 25, 2024
@parthea
See googleapis/synthtool#1916
ec5ca38
parthea added a commit to googleapis/proto-plus-python that referenced this pull request Jan 25, 2024
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#422)
9e9889d 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/python-ndb that referenced this pull request Jan 25, 2024
@parthea
See googleapis/synthtool#1916
66b2ef5
parthea added a commit to googleapis/python-ndb that referenced this pull request Jan 25, 2024
@parthea
See googleapis/synthtool#1916
578d9aa
rwhogg pushed a commit to googleapis/python-ndb that referenced this pull request Jan 26, 2024
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#939)
3cb2755 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* remove editable install to fix tests

* See googleapis/synthtool#1916

* See googleapis/synthtool#1916

* exclude .nox from coverage

* feat: Introduce compatibility with native namespace packages

* refactor unit test and coverage tests

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
@parthea parthea restored the fix-docs-build branch July 8, 2024 17:47
@parthea parthea deleted the fix-docs-build branch July 8, 2024 17:50
parthea added a commit to googleapis/google-cloud-python that referenced this pull request Jan 10, 2025
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#195)
5653e98 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/google-cloud-python that referenced this pull request Jan 10, 2025
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#78)
a627044 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/google-cloud-python that referenced this pull request Jan 10, 2025
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#260)
1e5c7b9 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/google-cloud-python that referenced this pull request Nov 24, 2025
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#422)
2293d30 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/google-cloud-python that referenced this pull request Nov 24, 2025
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#581)
5c2cced 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See python/typeshed#11254

* See googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/google-cloud-python that referenced this pull request Nov 24, 2025
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#272)
65f3c04 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

* See python/typeshed#11254

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea added a commit to googleapis/google-cloud-python that referenced this pull request Nov 24, 2025
@gcf-owl-bot @parthea
build(python): fix docs and docfx builds (#939)
4ca2e3c 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* remove editable install to fix tests

* See googleapis/synthtool#1916

* See googleapis/synthtool#1916

* exclude .nox from coverage

* feat: Introduce compatibility with native namespace packages

* refactor unit test and coverage tests

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea pushed a commit to googleapis/google-cloud-python that referenced this pull request Mar 2, 2026
@gcf-owl-bot @cojenco
build(python): fix docs and docfx builds (#418)
72a07d7 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* apply googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Cathy Ouyang <cathyo@google.com>
parthea added a commit to googleapis/google-cloud-python that referenced this pull request Mar 6, 2026
@gcf-owl-bot @parthea
chore(deps): bump jinja2 from 3.1.2 to 3.1.3 in /.kokoro (#852)
c8aafbb 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* See googleapis/synthtool#1916

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
parthea pushed a commit to googleapis/google-cloud-python that referenced this pull request Mar 9, 2026
@gcf-owl-bot @cojenco
build(python): fix docs and docfx builds (#1210)
7a1e77a 
* build(python): fix `docs` and `docfx` builds

Source-Link: googleapis/synthtool@fac8444
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:5ea6d0ab82c956b50962f91d94e206d3921537ae5fe1549ec5326381d8905cfa

* apply googleapis/synthtool#1916

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Cathy Ouyang <cathyo@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ohmayr ohmayr ohmayr approved these changes

@chingor13 chingor13 Awaiting requested review from chingor13

@bcoe bcoe Awaiting requested review from bcoe

Assignees

@dandhlee dandhlee

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@parthea @ohmayr @dandhlee