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

Auto reference links #1

Open
kawa-kokosowa opened this issue Feb 20, 2016 · 0 comments
Open

Auto reference links #1

kawa-kokosowa opened this issue Feb 20, 2016 · 0 comments

Comments

@kawa-kokosowa
Copy link
Owner

A friend said:

automatically replace references in docs with a link, if they are referencing a concept elsewhere.
Something similar to what we see in Wikipedia... Or sort of like Jira , where the parser sees something that might be a ticket name SUP-100, looks up to see if there's a ticket with that ID, and if so, replaces the text with a link to it.

So if you have a class "ClassyPythonClass" and there's a doc section for it (either pre-written or generated from docstrings perhaps), then the first reference in another section to that class could be a link to the docs for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant