DOC: Add copy_asset and copy_asset_file to extdev/utils #13077
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
picnixz
approved these changes
Oct 28, 2024
There was a problem hiding this comment.
Seems a good addition to me.
@AA-Turner Do you have future plans in making sphinx.util.* more private or not?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
copy_asset()andcopy_asset_file()to the Sphinx API > Utilities page.Preview:
Feature or Bugfix
Purpose
The page documents utility classes and functions to develop extensions with and I feel like
copy_asset()andcopy_asset_file()are common/valuable functions for extension development and should be highlighted in the docs.The functions were added in version 1.5 via this PR: #2744