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

Fix boto3 resource reference docs #4050

Merged
merged 1 commit into from
Mar 13, 2024

Conversation

jonathan343
Copy link
Contributor

Overview

This PR fixes a small bug with boto3 resource documentation generation (addresses #4030).

Specifically, if a boto3 resources has references, there is duplicate text generated in the "References" section as shown in the example below.

Example

Screenshot 2024-03-12 at 3 24 23 PM

Reference: https://boto3.amazonaws.com/v1/documentation/api/1.34.61/reference/services/opsworks/layer/index.html#references

Testing

To test this change, I generated boto3 docs with and without the changes and compared the two. There are 17 changes that are all identical to the one below:
Before

----------
References
----------



References are related resource instances that have a belongs-to relationship.
For more information about references refer to the :ref:`Resources Introduction Guide<references_intro>`.

These are the resource's available references:

.. toctree::
  :maxdepth: 1
  :titlesonly:


These are the resource's available references:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  stack

After

----------
References
----------



References are related resource instances that have a belongs-to relationship.
For more information about references refer to the :ref:`Resources Introduction Guide<references_intro>`.

These are the resource's available references:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  stack

@jonathan343 jonathan343 merged commit 23c0741 into boto:develop Mar 13, 2024
33 checks passed
aws-sdk-python-automation added a commit that referenced this pull request Mar 14, 2024
* release-1.34.63:
  Bumping version to 1.34.63
  Add changelog entries from botocore
  Fix boto3 resource reference docs (#4050)
hswong3i pushed a commit to alvistack/boto-boto3 that referenced this pull request Mar 15, 2024
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.

2 participants