WIP Reference docstrings for markdown documentations#145
Open
WIP Reference docstrings for markdown documentations#145
Conversation
Implemented as a pymarkdown extension using the gather_doclets function from Sphinx
Member
|
Ping @ptbrowne |
Contributor
Author
|
I think I was waiting for a review on this, I still think that it could be interesting to have this kind of functionality, particularly for technical tutorials where we explain the role of functions, like for connectors. |
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
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.
It is quite useful to reference docstrings inside tutorials. This PR brings this functionality by implementing a custom markdown extension.
The extensions bases itself on thee sphinxjs python module which provides extraction and indexing of the docstrings.
The result is that you can write
and
---> BaseKonnector#waitForTwoFaCodewill be replaced by :I made this PR a WIP because I want to gauge interest for it. I would welcome anybody testing the PR on his local machine also.