crawlee-python icon indicating copy to clipboard operation
crawlee-python copied to clipboard
verified publisher icon apify

Make identifiers clickable in the rendered API docs

Open vdusek opened this issue 1 year ago • 1 comments

  • Make identifiers of classes, functions, methods, etc., clickable in the generated API docs.
  • https://github.com/apify/crawlee-python/pull/624#discussion_r1816976508

vdusek avatar Oct 29 '24 06:10 vdusek

(Marginally) related to https://github.com/apify/crawlee/issues/2717 - we might want to use something like e.g. JSDoc's {@link Dataset}. In the best case, we'd like to render clickable links both in IDEs and on the web.

I'm not sure whether this aligns with Python project documentation standards; it might need more research.

barjin avatar Oct 29 '24 10:10 barjin