NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

Fix doc build#26817

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

timhoffm wants to merge1 commit intomatplotlib:mainfromtimhoffm:fix-doc-build

Closed

Fix doc build#26817

timhoffm wants to merge1 commit intomatplotlib:mainfromtimhoffm:fix-doc-build

Conversation

Copy link

Member

timhoffm commentedSep 18, 2023•
edited
Loading

Attempt to fix doc build failure introduced with#25272.

I suspect this is sphinx scoping:#25272 reused methods likeAxes.set_xbounds to generate documentation for Axes3D. However, a see also of invert_xaxis only searches within the same module (or class), and invert_xaxis is not documented for Axes3D. This PR broadens the search scope by using the leading dot. An alternative may be to attempt to explicitly document the missing methods for Axes3D (see#26818).

Only one of#26817,#26818 should be used, preferrably#26818 if it works out.

Fix doc build

0d8ec10

Attempt to fix doc build failure introduced withmatplotlib#25272.I suspect this is sphinx scoping:matplotlib#25272 reused methodslike `Axes.set_xbounds` to generate documentation for Axes3D. However,a see also of invert_xaxis only searches within the same module (orclass), and invert_xaxis is not documented for Axes3D. This PR broadensthe search scope by using the leading dot. An alternative may be toattempt to explicitly document the missing methods for Axes3D.