Skip to content

docs: document the API reference docs pipeline in DEVELOPER.md#697

Open
twishabansal wants to merge 1 commit into
docs/api-ref-backfillfrom
docs/api-ref-developer-guide
Open

docs: document the API reference docs pipeline in DEVELOPER.md#697
twishabansal wants to merge 1 commit into
docs/api-ref-backfillfrom
docs/api-ref-developer-guide

Conversation

@twishabansal

@twishabansal twishabansal commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds an API Reference Documentation section to the existing root DEVELOPER.md, documenting the docs feature (pydoc-markdown → Hugo/Docsy → gh-pages). Mirrors JS #388, adapted for Python.

Add an API Reference Documentation section to the existing DEVELOPER.md
covering the deploy workflow, version picker, backfill workflow (with preview),
and local builds.
@twishabansal twishabansal marked this pull request as ready for review June 22, 2026 11:24
@twishabansal twishabansal requested a review from a team as a code owner June 22, 2026 11:24
@twishabansal twishabansal added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jun 22, 2026
@twishabansal twishabansal marked this pull request as draft June 22, 2026 11:25
@twishabansal twishabansal marked this pull request as ready for review June 22, 2026 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do not merge Indicates a pull request not ready for merge, due to either quality or timing.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants