Skip to content

Remove sphinx autoapi templates #2464

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
Merged
VeckoTheGecko merged 4 commits into from
Jan 12, 2026
Merged

Remove sphinx autoapi templates #2464

VeckoTheGecko merged 4 commits into from
Jan 12, 2026

Conversation

@VeckoTheGecko
Copy link
Contributor

@VeckoTheGecko VeckoTheGecko commented Jan 12, 2026 •
edited
Loading

Fixes #2448

@VeckoTheGecko VeckoTheGecko changed the title 2448 crosslinking methods Remove sphinx autoapi templates Jan 12, 2026
@erikvansebille
Copy link
Member

erikvansebille commented Jan 12, 2026

Hmm, I'm not sure this PR fixes the issue, since now none of the classes and objects in the QuickStart tutorial are links. See https://parcels--2464.org.readthedocs.build/en/2464/getting_started/tutorial_quickstart.html. Have we not thrown out the baby with the bathwater?

@VeckoTheGecko
Copy link
Contributor Author

VeckoTheGecko commented Jan 12, 2026

since now none of the classes and objects in the QuickStart tutorial are links

They also weren't before https://docs.parcels-code.org/en/v4-dev/getting_started/tutorial_quickstart.html - which links in particular?

@erikvansebille
Copy link
Member

erikvansebille commented Jan 12, 2026

Ah sorry; I meant the ones implemented in #2442. See for example https://parcels--2442.org.readthedocs.build/en/2442/getting_started/tutorial_quickstart.html

But I now realise that hasn't merged yet

It would be good to see what this change does on that PR though; so could you change it to merge into the reference-API-links branch?

@VeckoTheGecko VeckoTheGecko force-pushed the 2448-crosslinking-methods branch from 7e8a9f4 to ab54a03 Compare January 12, 2026 14:03
@VeckoTheGecko VeckoTheGecko changed the base branch from v4-dev to reference-API-links January 12, 2026 14:03
@VeckoTheGecko
Copy link
Contributor Author

VeckoTheGecko commented Jan 12, 2026

It would be good to see what this change does on that PR though; so could you change it to merge into the reference-API-links branch?

done

@erikvansebille
Copy link
Member

erikvansebille commented Jan 12, 2026

Yay, works now (after 39d6627)
Screenshot 2026-01-12 at 15 52 01

@github-project-automation github-project-automation bot moved this from Backlog to Ready in Parcels development Jan 12, 2026
@VeckoTheGecko VeckoTheGecko merged commit 3d38eb6 into Parcels-code:reference-API-links Jan 12, 2026
10 of 11 checks passed
@github-project-automation github-project-automation bot moved this from Ready to Done in Parcels development Jan 12, 2026
@VeckoTheGecko VeckoTheGecko deleted the 2448-crosslinking-methods branch January 12, 2026 15:00
@VeckoTheGecko VeckoTheGecko mentioned this pull request Jan 13, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erikvansebille erikvansebille erikvansebille approved these changes

Assignees

No one assigned

Labels

None yet

Projects

Parcels development
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

DOC: Fix cross-referencing to API methods and functions

2 participants

@VeckoTheGecko @erikvansebille