Skip to content

Comments

docs: Fix nearly all xref errors and other doc warnings#3615

Merged
rickeylev merged 28 commits intobazel-contrib:mainfrom
rickeylev:docs.fix.xrefs
Feb 20, 2026
Merged

docs: Fix nearly all xref errors and other doc warnings#3615
rickeylev merged 28 commits intobazel-contrib:mainfrom
rickeylev:docs.fix.xrefs

Conversation

@rickeylev
Copy link
Collaborator

This fixes almost all the missing cross references. A small list of exceptions are
kept in the conf.py file.

Enables strict documentation checking (-W --keep-going) and fixes
various cross-reference errors, typos, and registration issues:

* sphinxdocs: Make  idempotent to handle duplicate registration.
* sphinxdocs: Add  to Bazel inventory.
* python: Fix typo  -> .
* python: Fix  references by removing  markup.
* python: Fix  references by using  markup.
* python: Fix formatting of  in .
* pypi: Fix duplicate labels and add missing anchors.
* gazelle: Add missing anchors for annotations.
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @rickeylev, 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 significantly enhances the quality and accuracy of the project's documentation by addressing a wide array of cross-reference errors and other warnings. It introduces stricter build configurations for Sphinx, refines internal linking mechanisms, and improves the underlying Sphinx extension to better manage documentation data. The changes aim to provide a more reliable and navigable documentation experience for users and developers.

Highlights

  • Documentation Build Configuration: The Sphinx build process has been configured to be more stringent by enabling nitpicky mode, treating warnings as errors, and continuing the build even after encountering errors. This ensures higher quality documentation.
  • Cross-Reference Resolution: Extensive updates were made to resolve nearly all missing cross-references within the documentation. This involved adding intersphinx_mapping for Python and Sphinx, expanding the nitpick_ignore_regex in conf.py, and correcting numerous Sphinx roles (e.g., obj to bzl:obj, type to obj, func to bzl:obj, flag to bzl:flag, rst:directive to rst:dir) across various markdown and .bzl files.
  • Internal Linking Improvements: Explicit anchors were added to several section headings (e.g., (creating-backport-prs)=, (pypi-dependencies)=, (annotation-ignore)=, (directive-python-extension)=) to improve the reliability and clarity of internal links within the documentation.
  • Sphinx Extension Enhancements: The custom Sphinx extension (sphinx_bzl/bzl.py) was improved to gracefully handle identical object registrations and to include a clear_doc method for more robust domain data management during documentation builds.
  • Typo Corrections: Several typos were corrected, including --boostrap_impl to --bootstrap_impl and experimtal_api.md to experimental_api.md, ensuring accuracy in flag names and file paths.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • CHANGELOG.md
    • Updated Sphinx cross-reference roles for various entries.
    • Corrected obj to flag for --stamp flag reference.
    • Corrected flag to obj for --workspace_status_command reference.
    • Corrected object to bzl:obj for python.single_version_override reference.
    • Removed obj role for pip_repository.experimental_target_platforms.
    • Updated documentation link to use full URL.
    • Corrected attr to obj for pip.default.whl_platform_tags attribute.
Activity
  • No human activity has been recorded on this pull request yet.
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
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 is an excellent pull request that significantly improves the quality and robustness of the documentation. The systematic fixes for cross-reference errors, typos, and markup across numerous files are well-executed. The enhancements to the sphinx_bzl extension, particularly the improved handling of missing references and the added robustness for incremental builds, are very valuable. Overall, this is a high-quality contribution that greatly benefits the project's documentation.

@rickeylev
Copy link
Collaborator Author

I have addressed all review comments.

@rickeylev
Copy link
Collaborator Author

I have addressed review comments

lol. I told it to resolve comments, it couldn't figure out how, so it just posted that. Well in any case, comments addressed.

@rickeylev rickeylev enabled auto-merge February 20, 2026 00:47
@rickeylev rickeylev added this pull request to the merge queue Feb 20, 2026
Merged via the queue into bazel-contrib:main with commit 4864378 Feb 20, 2026
4 checks passed
@rickeylev rickeylev deleted the docs.fix.xrefs branch February 20, 2026 00:58
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.

2 participants