Deploy httpcore2 docs as a standalone site#998
Conversation
Repoint the httpcore2 mkdocs config at pydantic/httpx2, align its mkdocstrings setup with the httpx2 site so the API reference and objects.inv render, and rewrite httpcore references to httpcore2. Add a second zensical build plus a Cloudflare Worker so the docs publish to httpcore2.pydantic.dev with their own objects.inv.
|
Docs preview: https://15ef8b18-httpx2-docs.pydantic.workers.dev |
Merging this PR will not alter performance
Comparing Footnotes
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d343a127aa
ℹ️ 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".
|
|
||
| nav: | ||
| - Introduction: 'index.md' | ||
| - Quickstart: 'quickstart.md' | ||
| - Requests, Responses, and URLs: 'requests-responses-urls.md' |
There was a problem hiding this comment.
Don't expose the unfinished requests page
Adding requests-responses-urls.md to the standalone nav makes this page part of the published httpcore2 docs, but the page still has an unclosed Python fence starting at src/httpcore2/docs/requests-responses-urls.md:25; as a result everything from “Responses” through the ::: httpcore2.Request/Response/URL directives is rendered as literal code instead of prose/API reference. Either close/fix that page before linking it or leave it out of the nav so the new standalone site doesn't publish a broken API page.
Useful? React with 👍 / 👎.
Move the httpx2 docs to docs/httpx2 and the httpcore2 docs to docs/httpcore2, each as a self-contained mkdocs project (mkdocs.yml, docs/ source, site/ output, wrangler.toml). Update the build/serve scripts and the Cloudflare deploy + preview jobs to the new paths.
|
I think this is a bit too much. We don't need 2 docs. |
Builds the httpcore2 docs as their own site at
httpcore2.pydantic.dev, with its ownobjects.inv. The previous standalonesrc/httpcore2/mkdocs.ymlwas never wired into the build and still pointed atencode/httpcore.src/httpcore2/mkdocs.ymlatpydantic/httpx2and align its mkdocstrings/theme/markdown config with the httpx2 site, so the::: httpcore2.XAPI references render.httpcore->httpcore2across the docs and repoint badge/PyPI/GitHub URLs.zensical buildstep and awrangler-httpcore2.tomlWorker; deploy + PR-preview jobs mirror the httpx2 ones.Verified locally: both sites build with no unresolved references, and
httpcore2.pydantic.dev/objects.invis emitted with properhttpcore2.*symbols (httpcore2.ConnectionPool,httpcore2.Proxy, etc.).Supersedes #997 (which merged the docs into the httpx2 site under a shared objects.inv).
Note:
httpcore2.pydantic.devmust be added as a custom domain in Cloudflare for the route to resolve.AI Disclaimer
This PR was developed with the assistance of either Claude or Codex. I've reviewed and verified the changes.