Jefffrey commented on issue #17071: URL: https://github.com/apache/datafusion/issues/17071#issuecomment-3419758266
Putting some notes here. I looked into comet as per Andy's comment, though I would prefer an approach where the entire site is versioned and not just a specific section. I played around with https://github.com/sphinx-contrib/multiversion to build multiple versions of the doc, but it requires each doc build step to clone all the previous versions and build which seems inefficient. It was also a bit fiddly to get working. I think the best approach is to follow what Arrow did; on each release they'll manually push the built docs for the version to their doc repo/branch, to maintain the history, whilst they still can push their latest docs from main onto docs website. Some references: - JIRA ticket: [[Doc] Host different released versions of the documentation + version switcher](https://issues.apache.org/jira/browse/ARROW-13260) - [`post-08-docs.sh`](https://github.com/apache/arrow/blob/bab558061696ddc1841148d6210424b12923d48e/dev/release/post-08-docs.sh) script which runs as part of their release process to upload the version doc - See how arrow doc source has all their versions: https://github.com/apache/arrow-site/tree/asf-site/docs - We're using `pydata_sphinx_theme` which has support for a version picker, see their doc: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html - For reference see Arrow's JSON file which lists their versions: https://github.com/apache/arrow/blob/main/docs/source/_static/versions.json I've been stretching myself a bit thin lately so I don't think I'll take this on 😅 There's also the matter of potentially adding a new step to the release process if we go with the Arrow approach, so might need some input from those who perform the releases on their thoughts for this (cc @alamb) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
