docs: Fix nearly all xref errors and other doc warnings#3615
docs: Fix nearly all xref errors and other doc warnings#3615rickeylev merged 28 commits intobazel-contrib:mainfrom
Conversation
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.
Summary of ChangesHello @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
🧠 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
Activity
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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.
|
I have addressed all 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. |
This fixes almost all the missing cross references. A small list of exceptions are
kept in the conf.py file.