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

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 6.0.1, 7.0.0
• Component/s: Documentation
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/30053
• Assignee: Joris Van den Bossche
• Reporter: Joris Van den Bossche
• Created: 28/Oct/21 09:37
• Updated: 11/Jan/23 08:40
• Resolved: 04/Nov/21 21:02

Description

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: https://github.com/sphinx-doc/sphinx/issues/701#issuecomment-659062227

Issue Links

• is duplicated by: ARROW-14497 [Docs] Use relative internal links in the sphinx docs
• links to: GitHub Pull Request #11601