You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Alessandro Molina (Jira)" <ji...@apache.org> on 2021/10/01 07:18:07 UTC
[jira] [Updated] (ARROW-13260) [Doc] Host different released
versions of the documentation + version switcher
[ https://issues.apache.org/jira/browse/ARROW-13260?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Alessandro Molina updated ARROW-13260:
--------------------------------------
Fix Version/s: (was: 6.0.0)
7.0.0
> [Doc] Host different released versions of the documentation + version switcher
> ------------------------------------------------------------------------------
>
> Key: ARROW-13260
> URL: https://issues.apache.org/jira/browse/ARROW-13260
> Project: Apache Arrow
> Issue Type: Improvement
> Components: Documentation
> Reporter: Joris Van den Bossche
> Assignee: Joris Van den Bossche
> Priority: Major
> Fix For: 7.0.0
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> Related to ARROW-1299 for hosting the nightly docs, we could also keep the built docs for older versions instead of overwriting them at each release.
> Currently, the built docs live in the apache/arrow-site repo (asf-site branch) in the "/docs/" subdirectory.
> When releasing, we could add the newly built docs for that release in a subdirectory instead. Something like "/docs/5.0/" or "/docs/version/5.0".
> (And we could retroactively add some docs of previous releases, if we want)
> To make this useful for the user, we need a version switcher in the sphinx theme layout. There are other projects that use the same sphinx theme that have added this (see eg https://mne.tools/stable/index.html), and there is some work to upstream this to the base theme (but on the short term we could also copy such a custom implementation).
> For the "stable" docs (latest release), we could either 1) keep a duplicated version of the latest built docs at "/docs/", or 2) symlink "/docs/" to "/docs/5.0/" (and update this for each release; although I am not sure this is possible since it's the other is a child directory).
> We could also add a "/docs/stable/" and make this the default url.
> cc [~amol-] [~kszucs]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)