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.

Sign up for GitHub

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

Jump to bottom

Cross reference API reference in docs #91

Open
rob-tay opened this issue Aug 6, 2021 · 0 comments
Open

Cross reference API reference in docs #91

rob-tay opened this issue Aug 6, 2021 · 0 comments
Labels
good first issue Good for newcomers status:triage

Comments

@rob-tay
Copy link
Contributor

rob-tay commented Aug 6, 2021

Is your feature request related to a problem? Please describe.
The documentation references object names in the user guides and tutorials but they are not cross-referenced to the respective entry in the API reference. It would be nicer to be able to click on the name and it takes you to the more detailed API reference for that object.

Describe the solution you'd like
Links to the respective API reference for any named objects in the documentation

Describe alternatives you've considered

Additional context
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers status:triage
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rob-tay