chore: make installation page comply with policy #3947
Conversation
lidavidm
left a comment
lidavidm
left a comment
There was a problem hiding this comment.
Thanks for doing this!
Is https://github.com/missinglinkelectronics/sphinxcontrib-globalsubs an option? (Though I guess not having a dependency is nice; that said sphinx-doc/sphinx#2173 implies that rst_prolog can be slow)
Right now release says something like 23 (dev). Do we want to have a separate variable for "latest available to download"? That can be updated by the version bump script.
|
https://github.com/missinglinkelectronics/sphinxcontrib-globalsubs seems worth a try. rst_prolog doesn't seem to have a measurable affect on build time but it's a bit of a coarse solution. Re: a new variable, I like that idea. I'll try that too. |
|
https://github.com/missinglinkelectronics/sphinxcontrib-globalsubs isn't on conda-forge so maybe we can stick with I pushed a change to add a new variable in 8500c1a. I didn't have a strong preference on the variable's name. |
| f".. |source_download| replace:: `apache-arrow-adbc-{quote(release)}.tar.gz <https://www.apache.org/dyn/closer.lua/arrow/apache-arrow-adbc-{quote(release)}/apache-arrow-adbc-{quote(release)}.tar.gz>`__\n" # noqa: E501 | ||
| f".. |source_checksum| replace:: `checksum <https://downloads.apache.org/arrow/apache-arrow-adbc-{quote(release)}/apache-arrow-adbc-{quote(release)}.tar.gz.sha512>`__\n" # noqa: E501 | ||
| f".. |source_signature| replace:: `signature <https://downloads.apache.org/arrow/apache-arrow-adbc-{quote(release)}/apache-arrow-adbc-{quote(release)}.tar.gz.asc>`__\n" # noqa: E501 | ||
| f".. |source_download| replace:: `apache-arrow-adbc-{quote(latest_release)}.tar.gz <https://www.apache.org/dyn/closer.lua/arrow/apache-arrow-adbc-{quote(latest_release)}/apache-arrow-adbc-{quote(latest_release)}.tar.gz>`__\n" # noqa: E501 |
There was a problem hiding this comment.
I guess I could remove the quote calls but I also guess they make this safer.
| sed -i.bak -E "s/latest_release = \".+\"/latest_release = \"${docs_version}\"/g" "${ADBC_DIR}/docs/source/conf.py" | ||
| rm "${ADBC_DIR}/docs/source/conf.py.bak" |
There was a problem hiding this comment.
I think this will work on release, but won't work on dev, right? docs_version will be 24 (dev). I think up top, we need to check if this is a release or snapshot; if snapshot use PREVIOUS_RELEASE from versions.env, else use RELEASE
2 participants
Updates the installation page to comply with https://infra.apache.org/release-download-pages.html#download-page. Uses
rst_prologbecause I couldn't figure out a better way to dynamically generate the URLs based on version.Closes #3946