How to specify relative links to API docs about scores

[tennlee]

So, this worked locally but raised a sphinx-build error. It seems to me like the autodoc command is generating the anchor in api.html after myst runs to generate the other html files. As such, at the time it's running, it thinks the cross-reference is missing in api.html. After some searching, I found out how to suppress the warning site-wide, not not a true fix. As such, we can do this, but it runs the risk of suppressing genuine cross-referencing errors between other files in the documentation.

Adding suppress_warnings = ['myst.xref_missing'] to conf.py suppresses the error.

I will try pushing the change to 228 and confirming it works as expected on the site proper, but I expect it will. So this is a possible way forward, but with some downsides.

[tennlee]

I have now quieted the cross-referencing error noted during build through a configuration setting in conf.py. This opens the door for changing API docstring links in the manner outlined above. It does not appear to be required to specify the project: prefix, just remove the URL prefix and change .html to .md.

[tennlee]

Example: [API](api.md#scores.continuous.additive_bias)

[nikeethr]

I have now quieted the cross-referencing error noted during build through a configuration setting in conf.py. This opens the door for changing API docstring links in the manner outlined above. It does not appear to be required to specify the project: prefix, just remove the URL prefix and change .html to .md.

I can’t remember now, but I think to reference tutorials I needed the “project:” prefix or it gets confused; but maybe my setup was being weird. It can be omitted for api.md