Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Links to code in API docs broken #287

Open
tomdonaldson opened this issue Nov 14, 2023 · 1 comment
Open

Links to code in API docs broken #287

tomdonaldson opened this issue Nov 14, 2023 · 1 comment

Comments

@tomdonaldson
Copy link

While browsing the API docs, I noticed that the links to the code resulted in a 404 at Github.

For example, on https://docs.worldwidetelescope.org/webgl-reference/latest/apiref/engine/classes/WWTControl-1.html#gotoRADecZoom, links like

Defined in engine/src/index.d.ts:2555

didn't work.

@pkgw
Copy link
Contributor

pkgw commented Nov 16, 2023

Ah, hm. It looks like the problem is with the commit ID embedded by typedoc when it builds the docs. It looks like it's autodetecting it by running git rev-parse --short HEAD, but for our non-release builds that commit is one that's created on-the-fly and never makes it back to GitHub.

It looks like we can adjust this value at invocation time, so I think we can work around this with a tweak to the CI script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants