You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "lidavidm (via GitHub)" <gi...@apache.org> on 2026/10/05 07:19:36 UTC
[PR] docs: generate for tagged releases [arrow-adbc]
lidavidm opened a new pull request, #4855:
URL: https://github.com/apache/arrow-adbc/pull/4855
This will only fix things going forward, and we'll eventually want some tool to correct past releases (possibly on an ongoing basis, e.g. because a page may stop existing and we'll want to point to the last version of the page or the replacement page as canonical instead).
Closes #4854.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: generate for tagged releases [arrow-adbc]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #4855:
URL: https://github.com/apache/arrow-adbc/pull/4855#discussion_r4181566750
##########
.github/workflows/nightly-website.yml:
##########
@@ -49,8 +49,13 @@ jobs:
fetch-depth: 0
persist-credentials: false
- name: Build
+ if: github.event_name != 'push' || !startsWith(github.ref, 'refs/tags/apache-arrow-adbc-')
run: |
docker compose run docs
+ - name: Build
+ if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/apache-arrow-adbc')
+ run: |
+ docker compose run docs -e ADBC_BASEURL="https://arrow.apache.org/adbc/current/"
Review Comment:
`docker compose run` requires run options before the service name. Here `-e` is parsed as the command for `docs`, replacing the service command, so tagged-release builds will fail instead of generating the site. Pass the environment option before `docs` (as the other workflow invocations do).
##########
docs/source/conf.py:
##########
@@ -141,6 +141,11 @@ def setup(app):
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+if (baseurl := os.environ.get("ADBC_BASEURL")) is not None:
+ # This causes Sphinx to generate <link rel=canonical> tags for search
+ # engines. We only want this for tagged releases.
+ html_baseurl = baseurl
Review Comment:
This only adds canonical links to Sphinx-rendered pages. The published site also replaces `cpp/api`, `java/api`, and `javascript/api` with Doxygen, Javadoc, and TypeDoc output after Sphinx finishes (`ci/scripts/docs_build.sh:68-74`), so those pages in both the versioned and `current/` trees still lack the canonical links requested by #4854. Please propagate the canonical base URL into those generators or post-process their HTML before publishing.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: generate for tagged releases [arrow-adbc]
Posted by "amoeba (via GitHub)" <gi...@apache.org>.
amoeba commented on PR #4855:
URL: https://github.com/apache/arrow-adbc/pull/4855#issuecomment-6064266163
PS: Adding examples of search results to the parent issue here would be really useful (record date, engine, and query) to help us track improvements.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: generate for tagged releases [arrow-adbc]
Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm commented on PR #4855:
URL: https://github.com/apache/arrow-adbc/pull/4855#issuecomment-6357743700
Alright, let's consider some other approaches...
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: generate for tagged releases [arrow-adbc]
Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm closed pull request #4855: docs: generate <link rel="canonical"> for tagged releases
URL: https://github.com/apache/arrow-adbc/pull/4855
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: generate for tagged releases [arrow-adbc]
Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm commented on code in PR #4855:
URL: https://github.com/apache/arrow-adbc/pull/4855#discussion_r4181583967
##########
docs/source/conf.py:
##########
@@ -141,6 +141,11 @@ def setup(app):
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+if (baseurl := os.environ.get("ADBC_BASEURL")) is not None:
+ # This causes Sphinx to generate <link rel=canonical> tags for search
+ # engines. We only want this for tagged releases.
+ html_baseurl = baseurl
Review Comment:
We'll have to handle this separately.
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org