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

#11599 Fix API reference link #11689

Merged
merged 3 commits into from Sep 27, 2022
Merged

#11599 Fix API reference link #11689

merged 3 commits into from Sep 27, 2022

Conversation

twm
Copy link
Contributor

@twm twm commented Sep 24, 2022

Scope and purpose

Use an intersphinx-style link rather than an absolute one so that the generated link is relative.

You can see the result here:

image

The monospace formatting is unfortunate but such is Sphinx. 🤷

Fixes #11599.

Contributor Checklist:

This process applies to all pull requests - no matter how small.
Have a look at our developer documentation before submitting your Pull Request.

Below is a non-exhaustive list (as a reminder):

  • The title of the PR should describe the changes and starts with the associated issue number, like “#9782 Remove twisted.news. #1234 Brief description”.
  • A release notes news fragment file was create in src/twisted/newsfragments/ (see: Release notes fragments docs.)
  • The automated tests were updated.
  • Once all checks are green, request a review by leaving a comment that contains exactly the string please review.
    Our bot will trigger the review process, by applying the pending review label
    and requesting a review from the Twisted dev team.

@twm twm changed the title 11599: Fix API reference link #11599 Fix API reference link Sep 24, 2022
Copy link
Member

@exarkun exarkun left a comment

Choose a reason for hiding this comment

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

Thanks! Great to have this link fixed.

@exarkun
Copy link
Member

exarkun commented Sep 27, 2022

Note - I enabled auto-merge.

@exarkun exarkun merged commit 1773b5d into trunk Sep 27, 2022
@exarkun exarkun deleted the 11599-api-reference-link branch September 27, 2022 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

"API reference" link should be local to the build documentation
3 participants