-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Sphinx domain fix #2880
Sphinx domain fix #2880
Conversation
Codecov ReportPatch coverage:
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more Additional details and impacted files@@ Coverage Diff @@
## develop #2880 +/- ##
========================================
Coverage 93.57% 93.57%
========================================
Files 63 63
Lines 13455 13457 +2
========================================
+ Hits 12590 12592 +2
Misses 865 865
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
👀 |
Added full method signature to client docs to support intersphinx.
Overview
We previously had all class and method documentation on the same service page, however, we implemented nested docs to decrease page size. In doing so, we broke the way sphinx handles cross-references since methods on individual pages (not in the
py:class
body) should have the full class name attached as explained here.Examples
Before Nested Docs:
Current:
New: