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

Goto source of function in API docs #73

Open
jgarte opened this issue Mar 9, 2021 · 1 comment
Open

Goto source of function in API docs #73

jgarte opened this issue Mar 9, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jgarte
Copy link

jgarte commented Mar 9, 2021

It would be great to have a way to go to the source definition of the function in the docs.

For example when looking at isOdd in the docs I would like to be able
to click a link that takes me to the source.

See here for an example of a python api that has the jump to source feature.

What are your thoughts on this feature in the docs?

Does rails offer a plugin for this? I'll research it a bit and report back.

@jgarte jgarte mentioned this issue Mar 9, 2021
6 tasks
@gdotdesign
Copy link
Member

I think it's a great idea!

In order to do this we need to export the source path to the documentation which Mint generates (https://github.com/mint-lang/mint/tree/master/src/documentation_generator for each node) after that it's more or less trivial to implement here.

Alternatively the source of a function is exported in the documentation so we can just display it.

This can stay as it's own issue.

@Sija Sija added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants