Repository navigation
Fix broken cross-references in the docs - #2969
Merged
Merged
Conversation
A nitpicky Sphinx build found about 160 references that went nowhere: typos, renamed or removed names, short names Sphinx can't find, roles that don't match the target (list and type are classes, callable is a function), and docstring lines napoleon misread as types. Most now point at the documented name; ones that have no page become plain literals. The hexagon and input modules, ComputeShader and RenderTargetTexture had no API pages, so references to them couldn't resolve. Adds those. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
Part 1 of #2297. The next PR turns on
nitpicky = True.A nitpicky build (
sphinx-build -n) reported 409 unresolved references. This PR fixes the ones that were really broken: links readers can click today that go nowhere, about 160 warnings. That group goes from 161 to 10. The other 265 are type variables, other libraries' internals and undocumented type aliases, which the second PR handles with config.What was wrong
interesectionallow_multi_jumps(should beallow_multi_jump)scale_multiply_uniform(should bemultiply_scale)add_spritelist(should beadd_sprite_list)unique_textures`(stray backtick):py:class:`TypeError.`(period inside the role)arcade.Camera(nowCamera2D)set_velocity_horizontal/set_velocity_vertical(nowset_horizontal_velocity; there is no vertical one)arcade.utils.ByteRangeError(now inarcade.exceptions)arcade.future.inputpathsUIMouseEvents,arcade.gui.UIElement,Limits.POINT_SIZE_RANGEBox.kwargsandBox.from_kwargs, which don't exist. TheBoxdocstring listed.from_kwargs, which linked toRect.from_kwargs.arcade.sprite.sprite.Sprite.*→arcade.Sprite.*arcade.gl.Context.*→arcade.gl.context.Context.*arcade.gl.Buffer→arcade.gl.buffer.Bufferarcade.tilemap.TileMap→arcade.tilemap.tilemap.TileMapSpriteList.geometry→SpriteListData.geometryView.on_show_view,UIScrollBar,DefaultProjectorlistandtypeare classes andcallableis a function, so:py:func:listand `:py:class:`callabledidn't resolve.Get or set the depth mask (default: ...)path Path to...)pan:descriptions with "and" inside parenthesesarcade.gl.backends,arcade.gui.experimentalas a module) are now plain literals instead of dead links.New API pages
These public modules and classes had no pages, so references to them could never resolve:
arcade.input), which the advanced input guide links toarcade.hexagon), which the hex map tutorial links toarcade.gl.compute_shader.ComputeShader), added to the OpenGL pagesRenderTargetTexture, added to the Future Features pageIncluding
InputManager's docstring surfaced a broken list and a link to a label that doesn't exist, so I fixed both.Left for the second PR
These come from type annotations in signatures, not from docstring text:
Pathandtuple[floatsh.SpatialHashannotations insprite_list.pyStyleReftype variableAllocatorException: pyglet's published docs are for 2.1, where it lives atpyglet.image.atlasTesting
-Wpasses.🤖 Generated with Claude Code