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

use sphinx references instead of hardcoded links. #1096

Merged
merged 1 commit into from
Oct 10, 2024
Merged

use sphinx references instead of hardcoded links. #1096

merged 1 commit into from
Oct 10, 2024

Conversation

fabianp
Copy link
Member

@fabianp fabianp commented Oct 9, 2024

several advantages:

  • looks nicer
  • doesn't break when the links change (and warns if the endpoint changes)
  • references the current version of the documentation (e.g., local links when building locally, and the latest version when building on readthedocs etc.)

@fabianp
use sphinx references instead of hardcoded links.
eefb79a 
several advantages:

  * looks nicer
  * doesn't break when the links change (and warns if the endpoint changes)
  * references the current version of the documentation (e.g., local links
    when building locally, and the latest version when building on readthedocs etc.)
@fabianp fabianp requested a review from vroulet October 9, 2024 06:38
@fabianp
Copy link
Member Author

fabianp commented Oct 9, 2024

FYI @carlosgmartin since I tweaked a bit your last example 😄

vroulet
vroulet approved these changes Oct 9, 2024
View reviewed changes
Copy link
Collaborator

@vroulet vroulet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@copybara-service copybara-service bot merged commit 6e23da8 into google-deepmind:main Oct 10, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vroulet vroulet vroulet approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fabianp @vroulet