Skip to content

Test the docs build in CI#49

Merged
samueljsb merged 6 commits intomainfrom
docs-in-ci
Sep 22, 2025
Merged

Test the docs build in CI#49
samueljsb merged 6 commits intomainfrom
docs-in-ci

Conversation

@samueljsb
Copy link
Collaborator

  • Exclude the built docs site
  • Test the docs build in CI
  • Use python version file for CI jobs
  • Move docs release job into 'build and publish' workflow
  • Only publish the docs when the package has been published
  • Rename publish job to pypi

Resolves #45

@samueljsb samueljsb requested a review from a team as a code owner September 22, 2025 13:56
Copy link
Collaborator

@meshy meshy left a comment

Choose a reason for hiding this comment

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

This is great, thanks! Only blocker is that I think we need to add cache keys before leaning into the pip caches.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Issue: If we're setting up the cache, I think we need to define a key per group.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ahh good point! I'll do that.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This action doesn't give us access to the key -- it's generated from the relevant files (in our case pyproject.toml). I'll remove it from here.

`mkdocs` builds the docs into a `site/` directory, which should not be
version-controlled.
This ensures the docs can always be built.
This allows us to update the Python version for all workflows in one
place.
This ensures we don't publish docs for non-existent versions, or where
there was some problem with the release process.
This clarifies what is being published (since another job publishes
the docs).
@samueljsb samueljsb merged commit 9d125d1 into main Sep 22, 2025
7 checks passed
@samueljsb samueljsb deleted the docs-in-ci branch September 22, 2025 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Build docs in CI

2 participants

Comments