Publish the Python SDK API reference at /docs/python from PyPI with pdoc - #92
Closed
arrufat wants to merge 3 commits into
Closed
Publish the Python SDK API reference at /docs/python from PyPI with pdoc#92arrufat wants to merge 3 commits into
arrufat wants to merge 3 commits into
Conversation
Add a workflow that regenerates public/python with pdoc from the lightpanda package on PyPI (daily, or by hand) and opens a pull request when the output changed. The static export copies public/ verbatim, so the website serves it at lightpanda.io/docs/python/ after the usual submodule bump. Seed it with the 0.4.0 package so the page exists on the next deploy, and keep Biome off the generated search.js.
This was referenced Sep 2, 2026
Point the hand-written Python SDK reference and the Python guide at the pdoc output published at lightpanda.io/docs/python/, with per-anchor links for Browser, AsyncBrowser, Session, AsyncSession, run_script and the error classes, and a pointer from the Calling an action section to the full method signatures.
# Conflicts: # src/content/guides/use-python.mdx # src/content/reference/python.mdx
Collaborator
Author
|
Closing: we are not publishing the pdoc reference for now. The docs links are removed in the follow-up PR instead. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
.github/workflows/python-reference.yml: daily (or by hand) it installs thelightpandapackage from PyPI, runs pdoc intopublic/python, and opens a pull request on thepython-referencebranch when the output changed. The static export copiespublic/verbatim, so the website serves the reference at https://lightpanda.io/docs/python/ after the usual submodule bump. No browser binary or cross-repo token is involved: the wheel already bundles the generated tool methods.public/pythonis seeded from the 0.4.0 package so the page exists on the next website deploy. pdoc's output is deterministic, so the scheduled run stays quiet until a new package is published.public(the generatedsearch.jsis not ours to lint).pypi.org/project/lightpandareference page and guide will link this URL (Python SDK docs: snake_case names and generated API reference link #91).Note for an admin: the workflow creates the pull request with
GITHUB_TOKEN, which needs "Allow GitHub Actions to create and approve pull requests" enabled under Settings → Actions → General. If it is off, the branch still gets pushed and the run fails at thegh pr createstep with that message.