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

WIP Reference docstrings for markdown documentations #145

Open
wants to merge 10 commits into
base: dev
Choose a base branch
from

Conversation

ptbrowne
Copy link
Contributor

@ptbrowne ptbrowne commented Sep 9, 2019

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

## Konnector tutorial

For 2FA you should use the waitForTwoFaCode function.

---> BaseKonnector#waitForTwoFaCode

and ---> BaseKonnector#waitForTwoFaCode will be replaced by :

Image collée à 2019-9-9 13-54

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.

@ptbrowne ptbrowne requested a review from drazik as a code owner September 9, 2019 12:03
@nono nono requested review from Crash-- and edas September 24, 2019 14:05
@nono
Copy link
Member

nono commented Feb 4, 2021

Ping @ptbrowne

@ptbrowne
Copy link
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.

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.

3 participants