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 link identifiers? #7

Open
makkus opened this issue Nov 23, 2019 · 3 comments
Open

Auto link identifiers? #7

makkus opened this issue Nov 23, 2019 · 3 comments
Labels
bug Something isn't working

Comments

@makkus
Copy link

makkus commented Nov 23, 2019

Hi there.

In the 'features' parts of the Readme it says: '...pdocs will automatically link identifiers in your docstrings to its corresponding documentation..'

I haven't been able to figure out how that works. I tried putting fully qualified identifiers betwen single backticks, but that does not seem to do anything? What's the correct way to do this?

@jay-tyler
Copy link
Contributor

Ok, I can reproduce this issue locally, and the docs here are pretty clear as to how this would work, if it was working.

There was some "surgery" involved in forking this repo from pdoc, and it looks like this feature might have been unintentionally lost as part of that.

Give me a little time (a week or two) and I'll try to come up with a PR for this.

@makkus
Copy link
Author

makkus commented Dec 22, 2019

Thanks, no rush. It's not that important, I was just wondering whether there is something obvious I'm missing.

@tony
Copy link

tony commented Aug 2, 2020

@timothycrosley @jay-tyler Hi there!

Firstly, thank you for the project(s)! That means both pdocs and portray :)

Any updates on this?

To clarify - linking of identifiers doesn't work?

(I am using portray at the moment and noticed the identifiers are not linking, but the docs make it appear like they should)

Also, it seems here https://timothycrosley.github.io/pdocs/reference/pdocs/#linking-to-other-identifiers they are broke on the projects own docs at the moment (those should be linking, right?)

@timothycrosley timothycrosley added the bug Something isn't working label Aug 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

4 participants