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

Updated signatures to support sphinx domain #3615

Merged
merged 3 commits into from Mar 16, 2023
Merged

Updated signatures to support sphinx domain #3615

merged 3 commits into from Mar 16, 2023

Conversation

jonathan343
Copy link
Contributor

@jonathan343 jonathan343 commented Mar 6, 2023

Note: Should be merged after botocore's #2880. Before this happens, tests are expected to fail.

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()

@tim-finnigan tim-finnigan linked an issue Mar 6, 2023 that may be closed by this pull request
Copy link
Contributor

@nateprewitt nateprewitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonathan343 jonathan343 merged commit 12dddb1 into boto:develop Mar 16, 2023
16 checks passed
aws-sdk-python-automation added a commit that referenced this pull request Mar 16, 2023
* release-1.26.93:
  Bumping version to 1.26.93
  Add changelog entries from botocore
  Updated signatures to support sphinx domain (#3615)
  Support doc page redirects for ALL services (#3613)
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.

Intersphinx Inventory broken as of 1.26.81
2 participants