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

Docs: make class/function names link through to API reference more consistently #78

Open
1 task
Tom-Willemsen opened this issue Nov 23, 2024 · 0 comments
Open
1 task

Docs: make class/function names link through to API reference more consistently #78

Tom-Willemsen opened this issue Nov 23, 2024 · 0 comments
Assignees
@danielmaclaren
Labels
2 good first issue Good for newcomers in progress

Comments

@Tom-Willemsen
Copy link
Contributor

Tom-Willemsen commented Nov 23, 2024 •
edited by GRyall
Loading

Go through existing docs, and wherever we talk about details of a particular class/function, make sure it links through to API docs to get more details

Sytax example for sphinx:

{py:obj}`ibex_bluesky_core.plan_stubs.call_sync`

Acceptance criteria

  • All links exist to API Docs

Planning

10/01/25 - 00:26:15
@Tom-Willemsen Tom-Willemsen added the good first issue Good for newcomers label Nov 25, 2024
@KathrynBaker KathrynBaker removed this from PI_2024_08 Jan 9, 2025
@GRyall GRyall added the 2 label Jan 10, 2025
@KathrynBaker KathrynBaker moved this to Backlog in PI_2025_02 Jan 10, 2025
@danielmaclaren danielmaclaren self-assigned this Jan 28, 2025
@danielmaclaren danielmaclaren moved this from Backlog to In Progress in PI_2025_02 Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@danielmaclaren danielmaclaren

Labels
2 good first issue Good for newcomers in progress
Projects
PI_2025_02
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
4 participants
@GRyall @Tom-Willemsen @ISISBuilder @danielmaclaren