You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "amoeba (via GitHub)" <gi...@apache.org> on 2026/04/16 23:36:31 UTC
[PR] docs(javascript): create basic scaffold for typedoc js docs [arrow-adbc]
amoeba opened a new pull request, #4238:
URL: https://github.com/apache/arrow-adbc/pull/4238
Adds TypeDoc docs for the JS implementation and an intersphinx config to integrate it with the Sphinx docs. There's a sphinx-js package but when I tried to integrate it with our conda environment I ran into all kinds of compatibility issues. I had an agent build a manual system like we already have for Java and it seems to work well enough.
Follow on to https://github.com/apache/arrow-adbc/pull/4232
Closes #4237
--
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(javascript): create basic scaffold for typedoc js docs [arrow-adbc]
Posted by "lidavidm (via GitHub)" <gi...@apache.org>.
lidavidm merged PR #4238:
URL: https://github.com/apache/arrow-adbc/pull/4238
--
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(javascript): create basic scaffold for typedoc js docs [arrow-adbc]
Posted by "amoeba (via GitHub)" <gi...@apache.org>.
amoeba commented on PR #4238:
URL: https://github.com/apache/arrow-adbc/pull/4238#issuecomment-4270045100
Aside: The package-lock.json issue seen here in CI seems to be entirely due me using a newer Node.js version on my Mac (25) than we use on CI (22). Switching to `v22.22.2` locally seems to help.
--
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(javascript): create basic scaffold for typedoc js docs [arrow-adbc]
Posted by "amoeba (via GitHub)" <gi...@apache.org>.
amoeba commented on PR #4238:
URL: https://github.com/apache/arrow-adbc/pull/4238#issuecomment-4264251483
CI failure in https://github.com/apache/arrow-adbc/actions/runs/24539617469/job/71742409243?pr=4238 is, I think, CI really not liking the package-lock generated by the super old npm version in the ADBC conda env I had laying around (11.x).
--
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(javascript): create basic scaffold for typedoc js docs [arrow-adbc]
Posted by "amoeba (via GitHub)" <gi...@apache.org>.
amoeba commented on PR #4238:
URL: https://github.com/apache/arrow-adbc/pull/4238#issuecomment-4264278939
Rebased and used references in the quickstart.rst now that we can use them. Need to double check them still.
--
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(javascript): create basic scaffold for typedoc js docs [arrow-adbc]
Posted by "amoeba (via GitHub)" <gi...@apache.org>.
amoeba commented on PR #4238:
URL: https://github.com/apache/arrow-adbc/pull/4238#issuecomment-4270395532
I just marked this as ready for review. To test and preview locally, I ran `docker compose run docs` and looked at the output. The things I looked for were:
- [x] The typedoc site looks reasonable and seems correct
- [x] The typedoc site is included at `javascript/api`, replacing the placeholder `javascript/api/index.rst`
- [x] The `external+js_adbc...` refs work in the sense that they turn into links to `typedoc.home.arpa` which gets resolved at build time
--
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(javascript): create basic scaffold for typedoc js docs [arrow-adbc]
Posted by "amoeba (via GitHub)" <gi...@apache.org>.
amoeba commented on PR #4238:
URL: https://github.com/apache/arrow-adbc/pull/4238#issuecomment-4264149134
This isn't ready for merge, I pushed to double check the build on CI since I was having issues locally.
I need to rebase after https://github.com/apache/arrow-adbc/pull/4232 is merged and double check the intersphinx part works.
--
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(javascript): create basic scaffold for typedoc js docs [arrow-adbc]
Posted by "amoeba (via GitHub)" <gi...@apache.org>.
amoeba commented on PR #4238:
URL: https://github.com/apache/arrow-adbc/pull/4238#issuecomment-4264253158
CI still failed in https://github.com/apache/arrow-adbc/actions/runs/24540441213/job/71744862595?pr=4238. I removed the bits in the diff manually, I'm no sure what's causing it.
--
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