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

[Docs] Ensure links to non-sphinx parts of the docs are relative instead of absolute #30053

Closed
Tracked by #28941
asfimport opened this issue Oct 28, 2021 · 2 comments
Closed
Tracked by #28941

Comments

@asfimport
Copy link
Collaborator

asfimport commented Oct 28, 2021

Currently we have some hardcoded links in the sphinx toctree to other parts of the docs (eg to <https://arrow.apache.org/docs/c_glib/, or https://arrow.apache.org/docs/r/).

That means that for the versioned docs, those links still are absolute links, and not pointing to the versioned ones.

For those parts of the docs that we include in the versioning (so those that are hosted in the github pages, which is the case for C/GLib, js and R, and not the case for C#, Go, Rust, Julia, Matlab and Ruby), we should see if we can trick sphinx in creating a relative url (which in principle only is possible for internal links to another part of the sphinx docs).

https://stackoverflow.com/questions/27979803/external-relative-link-in-sphinx-toctree-directive has some potential ideas

See also thread on github issue: sphinx-doc/sphinx#701 (comment)

Reporter: Joris Van den Bossche / @jorisvandenbossche
Assignee: Joris Van den Bossche / @jorisvandenbossche

Related issues:

PRs and other links:

Note: This issue was originally created as ARROW-14496. Please see the migration documentation for further details.

@asfimport
Copy link
Collaborator Author

Krisztian Szucs / @kszucs:
@jorisvandenbossche Any chance that you have time to work on it? Would make it easier to make the multi-version doc migration right after the 6.0.1 release.

@asfimport
Copy link
Collaborator Author

Krisztian Szucs / @kszucs:
Issue resolved by pull request 11601
#11601

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

No branches or pull requests

2 participants