Deploy docs to GitHub Pages and Cloudflare Workers#993
Conversation
Add CI to publish the docs on tag releases (GitHub Pages and Cloudflare Workers Static Assets) plus Cloudflare PR previews, matching the Starlette setup. Move the Cloudflare config to a root wrangler.toml and drop the docs-site directory. Build docs with a clean cache so objects.inv is populated.
The previous commit landed only the config move; this adds the GitHub Pages and Cloudflare Workers deploy jobs, the PR preview job, the documentation artifact build, the .wrangler ignore, and the clean docs build.
Merging this PR will not alter performance
Comparing 
Footnotes
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 59a32cff0b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1,10 @@ | |||
| name = "httpx2-docs" | |||
There was a problem hiding this comment.
This adds the root Worker config, but the checked workflow files still never build or deploy the docs: .github/workflows/publish.yml still only runs uv build --all-packages and uploads package-distributions, while a repo-wide search for wrangler, documentation, and docs-cloudflare only finds this config. On tag releases the new Cloudflare/Pages setup is therefore unused, so docs will not be published unless the missing publish/preview jobs are added or another deploy path is restored.
Useful? React with 👍 / 👎.
|
Docs preview: https://75961a79-httpx2-docs.pydantic.workers.dev |
1 participant
Sets up docs deployment for httpx2, matching the Starlette setup.
publish.yml: thebuildjob now also builds the docs and uploads adocumentationartifact; newdocs-publish(GitHub Pages) anddocs-cloudflare(Workersdeploy) jobs publish it on tag releases.main.yml: newdocs-cloudflare-previewjob uploads a versioned preview per PR and comments the URL.wrangler.toml: replacesdocs-site/with a root config (Starlette structure), keeping thehttpx2-docsworker name and thehttpx2.pydantic.devcustom domain.scripts/build: build with a clean cache (-c) soobjects.invis regenerated populated - zensical's incremental cache was emitting an empty inventory.Requires the
cloudflareandgithub-pagesenvironments plus theCLOUDFLARE_API_TOKEN/CLOUDFLARE_ACCOUNT_IDsecrets to be configured on the repo.AI Disclaimer
This PR was developed with the assistance of either Claude or Codex. I've reviewed and verified the changes.