Skip to content

fix doc building to only build for releases #270

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

Merged
merged 1 commit into from
Mar 4, 2025

Conversation

sofuture
Copy link
Contributor

@sofuture sofuture commented Mar 4, 2025

Changelog

None

Docs

None

Description

Fix python docs building to run only after Python release.

@sofuture sofuture force-pushed the jz/fix-python-doc-building branch from 0204c08 to e97a03b Compare March 4, 2025 15:37
@sofuture sofuture marked this pull request as ready for review March 4, 2025 15:56
@@ -42,18 +42,6 @@ jobs:
- run: poetry run mypy .
- run: poetry run python -m unittest
working-directory: python/foxglove-sdk/python
- name: Sphinx build
run: |
poetry run sphinx-build --fail-on-warning ./python/docs _build
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should keep this step to ensure that docs continue to build successfully. We could rename the job if it's confusing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This will still build on non-release, it will not publish though:

https://github.com/foxglove/foxglove-sdk/actions/runs/13657311996/job/38179804468 this is from this PR

@sofuture sofuture merged commit ad292c5 into main Mar 4, 2025
36 checks passed
@sofuture sofuture deleted the jz/fix-python-doc-building branch March 4, 2025 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants