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

"API reference" link should be local to the build documentation #11599

Closed
twm opened this issue Aug 13, 2022 · 2 comments · Fixed by #11689
Closed

"API reference" link should be local to the build documentation #11599

twm opened this issue Aug 13, 2022 · 2 comments · Fixed by #11689
Assignees

Comments

@twm
Copy link
Contributor

twm commented Aug 13, 2022

On this page (built based on PR #11598) the "API reference" link points at https://twistedmatrix.com/documents/current/api/ but it should it be a relative link that points at the version that was built as part of the PR, https://twisted--11598.org.readthedocs.build/en/11598/api/index.html

@twm twm self-assigned this Aug 13, 2022
@adiroiban
Copy link
Member

Thanks.

Maybe also have this, since the docs are no longer hosted by us.
Maybe also add that the docs are hosted by Read The Docs

- An [API reference](https://twistedmatrix.com/documents/current/api/) is available on the twistedmatrix web site.
+ An [API reference](../) is available as part of the documentation site.
- An [API reference](https://twistedmatrix.com/documents/current/api/) is available on the twistedmatrix web site.
+ An [API reference](../) is available as part of the documentation site, hosted by Read The Docs.

@twm
Copy link
Contributor Author

twm commented Aug 14, 2022

When viewing this page the user is already on Read the Docs so I'm not sure what that would add?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants