pdocs icon indicating copy to clipboard operation
pdocs copied to clipboard

Auto link identifiers?

Open makkus opened this issue 5 years ago • 3 comments

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?

makkus avatar Nov 23 '19 12:11 makkus

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.

jay-tyler avatar Dec 19 '19 20:12 jay-tyler

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

makkus avatar Dec 22 '19 13:12 makkus

@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?)

tony avatar Aug 02 '20 14:08 tony