enable preliminary linkcode support #767
Merged
Conversation
This file contains hidden or 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
For `sphinx.ext.linkcode` references, the original handling of these nodes would right-align the links for the "[source]" references. Using a div-float for this alignment is not supported with Confluence's new editor style. For an initial rendering support for this preliminary linkcode support, ensure the link is place appropriately on the same link as a autodoc line description, and that the content is properly spaced. Signed-off-by: James Knight <[email protected]>
For `sphinx.ext.linkcode` extension, prospect changes [1] will provide support for other Sphinx extensions to take advantage of linkcode-generated references. Updating this extension to hint that it will support `sphinx.ext.linkcode`. This should help ensure a future release the Confluence Builder extension will automatically be ready to utilize the Sphinx-managed extension (if Sphinx does update to include linkcode support for custom builders). If Sphinx changes the way of integrating with linkcode or opts to not support such an extension, the introduced line in this commit can be modified or dropped at a later time. [1]: sphinx-doc/sphinx#10585 Signed-off-by: James Knight <[email protected]>
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.
For
sphinx.ext.linkcodeextension, prospect changes [1] will provide support for other Sphinx extensions to take advantage of linkcode-generated references. Updating this extension to hint that itwill support
sphinx.ext.linkcode. This should help ensure a future release the Confluence Builder extension will automatically be ready to utilize the Sphinx-managed extension (if Sphinx does update to include linkcode support for custom builders).If Sphinx changes the way of integrating with linkcode or opts to not support such an extension, the introduced line in this commit can be modified or dropped at a later time.
[1]: sphinx-doc/sphinx#10585