Skip to content
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

Merged
merged 6 commits into from
Mar 16, 2023
Merged

Sphinx domain fix #2880

merged 6 commits into from
Mar 16, 2023

Conversation

jonathan343
Copy link
Contributor

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:

# Page: <service>.html
.. py:class:: Foo
   .. py:method:: bar()

Current:

# Page: <service>.html
.. py:class:: Foo.Client

# Page: <method>.html
.. py:method:: bar()

New:

# Page: <service>.html
.. py:class:: Foo.Client

# Page: <method>.html
.. py:method:: Foo.Client.bar()

@codecov-commenter
Copy link

codecov-commenter commented Mar 6, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (1fb4d3a) 93.57% compared to head (f98ea82) 93.57%.

📣 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           
Impacted Files Coverage Δ
botocore/docs/client.py 100.00% <100.00%> (ø)
botocore/docs/method.py 94.11% <100.00%> (+0.05%) ⬆️

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.
📢 Do you have feedback about the report comment? Let us know in this issue.

tests/unit/docs/test_client.py Show resolved Hide resolved
botocore/docs/client.py Outdated Show resolved Hide resolved
@potiuk
Copy link

potiuk commented Mar 15, 2023

👀

@jonathan343 jonathan343 merged commit 18970fa into boto:develop Mar 16, 2023
aws-sdk-python-automation added a commit that referenced this pull request Mar 16, 2023
* release-1.29.93:
  Bumping version to 1.29.93
  Update to latest partitions and endpoints
  Update to latest models
  Sphinx domain fix (#2880)
  docs: add required blank line after code example literal blocks in rst (#2887)
  Support doc page redirects for ALL services (#2879)
jonathan343 added a commit to jonathan343/botocore that referenced this pull request Mar 17, 2023
Added full method signature to client docs to support intersphinx.
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.

5 participants