Skip to content

Deploy httpcore2 docs as a standalone site#998

Closed
Kludex wants to merge 2 commits into
mainfrom
httpcore2-docs-site
Closed

Deploy httpcore2 docs as a standalone site#998
Kludex wants to merge 2 commits into
mainfrom
httpcore2-docs-site

Conversation

@Kludex
Copy link
Copy Markdown
Member

@Kludex Kludex commented May 31, 2026

Builds the httpcore2 docs as their own site at httpcore2.pydantic.dev, with its own objects.inv. The previous standalone src/httpcore2/mkdocs.yml was never wired into the build and still pointed at encode/httpcore.

  • Repoint src/httpcore2/mkdocs.yml at pydantic/httpx2 and align its mkdocstrings/theme/markdown config with the httpx2 site, so the ::: httpcore2.X API references render.
  • Rewrite httpcore -> httpcore2 across the docs and repoint badge/PyPI/GitHub URLs.
  • Add a second zensical build step and a wrangler-httpcore2.toml Worker; deploy + PR-preview jobs mirror the httpx2 ones.

Verified locally: both sites build with no unresolved references, and httpcore2.pydantic.dev/objects.inv is emitted with proper httpcore2.* symbols (httpcore2.ConnectionPool, httpcore2.Proxy, etc.).

Supersedes #997 (which merged the docs into the httpx2 site under a shared objects.inv).

Note: httpcore2.pydantic.dev must 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.

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.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 31, 2026

Docs preview: https://15ef8b18-httpx2-docs.pydantic.workers.dev
httpcore2 docs preview:

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 31, 2026

Merging this PR will not alter performance

✅ 15 untouched benchmarks
⏩ 7 skipped benchmarks1


Comparing httpcore2-docs-site (09897f9) with main (999da32)

Open in CodSpeed

Footnotes

  1. 7 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 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".

Comment thread docs/httpcore2/mkdocs.yml

nav:
- Introduction: 'index.md'
- Quickstart: 'quickstart.md'
- Requests, Responses, and URLs: 'requests-responses-urls.md'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge 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.
@Kludex
Copy link
Copy Markdown
Member Author

Kludex commented May 31, 2026

I think this is a bit too much. We don't need 2 docs.

@Kludex Kludex closed this May 31, 2026
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.

1 participant