Skip to content

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

@asfimport

Description

@asfimport

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.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions