You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Joris Van den Bossche (Jira)" <ji...@apache.org> on 2021/10/28 10:34:00 UTC

[jira] [Commented] (ARROW-14498) [Docs] Make it possible to regenerate older docs with additional patch(es)

    [ https://issues.apache.org/jira/browse/ARROW-14498?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17435314#comment-17435314 ] 

Joris Van den Bossche commented on ARROW-14498:
-----------------------------------------------

Personally, I don't think we need to do this 1) for all versions, and 2) make this a habit. 

It's only now when introducing the versioned docs it's useful to regenerate some older versions (I was personally thinking to only do it for 5.0, and we don't even _have_ to do it at all). 

Also, for older versions, it's not a given that the current theme will work nicely with older sphinx versions. And more importantly, those patches probably won't apply cleanly to those older docs since many other things have changed in the meantime (eg the older docs before 4.0 actually use a different sphinx theme, so practically speaking it's only 4.0 and 5.0 that _could_ be regenerated).

> [Docs] Make it possible to regenerate older docs with additional patch(es)
> --------------------------------------------------------------------------
>
>                 Key: ARROW-14498
>                 URL: https://issues.apache.org/jira/browse/ARROW-14498
>             Project: Apache Arrow
>          Issue Type: Wish
>          Components: Documentation
>            Reporter: Krisztian Szucs
>            Priority: Major
>             Fix For: 7.0.0
>
>
> We may need to regenerate older docs to include new changes, e.g. the new version dropdown feature. 
> Since we need to regenerate the docs for the first time, it would be great if we could encapsulate this in a script. After applying the patch {{archery docker run ubuntu-docs}} should do the rest, similarly like we use in the post-release task https://github.com/apache/arrow/blob/master/dev/release/post-09-docs.sh
> ```
> dev/release/generate-docs.sh <version> <patch>
> dev/release/generate-docs.sh 6.0.0  # no patch required
> dev/release/generate-docs.sh 5.0.0 docs.patch
> dev/release/generate-docs.sh 4.0.0 docs.patch
> dev/release/generate-docs.sh 3.0.0 docs.patch
> # then deploy to asf-site
> ```
> cc [~jorisvandenbossche]



--
This message was sent by Atlassian Jira
(v8.3.4#803005)