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

Make identifiers clickable in the rendered API docs #625

Open
vdusek opened this issue Oct 29, 2024 · 1 comment
Open

Make identifiers clickable in the rendered API docs #625

vdusek opened this issue Oct 29, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation. t-tooling Issues with this label are in the ownership of the tooling team.

Comments

@vdusek
Copy link
Collaborator

vdusek commented Oct 29, 2024

@vdusek vdusek added documentation Improvements or additions to documentation. t-tooling Issues with this label are in the ownership of the tooling team. labels Oct 29, 2024
@vdusek vdusek changed the title Make identifiers clickable in the rendered API documentation Make identifiers clickable in the rendered API docs Oct 29, 2024
@barjin
Copy link
Contributor

barjin commented Oct 29, 2024

(Marginally) related to apify/crawlee#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.

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. t-tooling Issues with this label are in the ownership of the tooling team.
Projects
None yet
Development

No branches or pull requests

2 participants