sphinx.ext.linkcode Improvements
#1044
Merged
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
Updating the `confluence` and `singleconfluence` builders to use their explicit names to be used for linkcode support. The original support used a value of `True` which appeared to work; however, now appears to generate a warning. Using explicit names prevents this. Signed-off-by: James Knight <james.d.knight@live.com>
Upcoming changes to Sphinx v8.1 includes linkcode changes which should allow support with this extension. Updating the features document to notify users. Signed-off-by: James Knight <james.d.knight@live.com>
Signed-off-by: James Knight <james.d.knight@live.com>
Adding an example of the linkcode extension into the validation set. Signed-off-by: James Knight <james.d.knight@live.com>
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.
Updating the
confluenceandsingleconfluencebuilders to use their explicit names to be used for linkcode support. The original support used a value ofTruewhich appeared to work; however, now appears to generate a warning. Using explicit names prevents this.Additional documentation and validation changes as well.