[
https://issues.apache.org/jira/browse/ARROW-14496?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Joris Van den Bossche updated ARROW-14496:
------------------------------------------
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
was:
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
> [Docs] Ensure links to non-sphinx parts of the docs are relative instead of
> absolute
> ------------------------------------------------------------------------------------
>
> Key: ARROW-14496
> URL: https://issues.apache.org/jira/browse/ARROW-14496
> Project: Apache Arrow
> Issue Type: Sub-task
> Components: Documentation
> Reporter: Joris Van den Bossche
> Priority: Major
>
> 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
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
