Skip to content

docs: Bring back Python SDK reference#1415

Merged
holtskinner merged 1 commit intomainfrom
ishymko/python-sdk-docs
Jan 26, 2026
Merged

docs: Bring back Python SDK reference#1415
holtskinner merged 1 commit intomainfrom
ishymko/python-sdk-docs

Conversation

@ishymko
Copy link
Copy Markdown
Member

@ishymko ishymko commented Jan 26, 2026

Currently SDK Reference > Python link gives 404:

image
  1. Fix the link to open this instead. This was setup in docs: Update Python SDK Docs to use Sphinx #949 and is generated automatically from the latest docs. Looks like it was accidentally changed to python.md (the one not used ever before, it used to be python/index.md) in docs(spec): Large refactor of specification to separate application protocol definition from mapping to transports. #1160.
  2. Fix redirect to use absolute URL with latest. This is required due to Existing .html Redirect mkdocs/mkdocs-redirects#18, current way isn't going to work. v0.3.0 tag of the website (the one you get after clicking Latest Released Version from here) doesn't have the generated documentation either way, see here.
  3. Replace Google LLC with The Linux Foundation in the generated SDK reference.
  4. Update copyright year in both places.

Tested via mkdocs serve.

Fixes #1347.

@ishymko ishymko requested review from a team as code owners January 26, 2026 11:53
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @ishymko, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves a critical issue where the Python SDK reference link in the documentation was broken, preventing users from accessing essential API information. By updating the navigation link to the correct, auto-generated path, it significantly improves the user experience for developers seeking Python SDK details. Furthermore, the changes ensure that all copyright and authorship information across the documentation is current and accurately reflects 'The Linux Foundation' as the project's steward.

Highlights

  • Documentation Link Fix: The broken link for the Python SDK reference in the documentation navigation has been corrected to point to the automatically generated API documentation.
  • Copyright and Author Updates: The copyright year has been updated to 2026 in both the Python SDK configuration and the main documentation configuration. Additionally, the author and copyright holder in the Python SDK configuration have been changed from 'Google LLC' to 'The Linux Foundation'.
  • Configuration Alignment: The Python SDK configuration file (conf.py) now correctly reflects 'The Linux Foundation' as the author and copyright holder, aligning with the project's current stewardship.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly fixes a broken link to the Python SDK reference and updates copyright information across the documentation configuration. I've added a couple of minor suggestions to automate the copyright year updates in both mkdocs.yml and docs/sdk/python/conf.py. This would improve long-term maintainability by removing the need for manual year changes. Otherwise, the changes look good.

@ishymko ishymko marked this pull request as draft January 26, 2026 12:27
@ishymko ishymko force-pushed the ishymko/python-sdk-docs branch from a2a3809 to 373a50a Compare January 26, 2026 12:32
@ishymko ishymko marked this pull request as ready for review January 26, 2026 12:34
@ishymko ishymko requested a review from holtskinner January 26, 2026 12:38
@ishymko ishymko force-pushed the ishymko/python-sdk-docs branch from 373a50a to 4fce3ba Compare January 26, 2026 12:41
@holtskinner holtskinner merged commit bb527d4 into main Jan 26, 2026
15 checks passed
@holtskinner holtskinner deleted the ishymko/python-sdk-docs branch January 26, 2026 16:12
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.

[Bug]: broken link to SDK Reference > Python

2 participants