Yep, that’s right @sritchie09, what cljdoc calls wikilinks [[my.ns/myfn]]
are only available from docstrings.
I wondered out loud about this too a while back and @martinklepsch https://clojurians-log.clojureverse.org/cljdoc/2020-09-30/1601496404.020000 that
> These links wouldn’t work on GitHub etc. and linking already is possible/practical with using CURRENT
as version
got it!
good to know that the base thing we want is that docs should also be just as readable from the github source tree
personally I would argue that it might be nice to expose more in cljdocs but you’re right, this is workable, maybe with some emacs wizardry to auto-write the links
hey all, one Q - what’s the style for linking to clojure.core functions?
[[clojure.core/apply]] tries to link to sicmutils.clojure.core/apply
here: https://cljdoc.org/d/sicmutils/sicmutils/0.14.0/api/sicmutils.clojure.core#apply
https://cljdoc.org/d/sicmutils/sicmutils/0.14.0/api/sicmutils.expression#literal-apply
in this docstring
@sritchie09 sorry about that, the wikilinks links are actually resolved within your project and so linking to clojure.core like that doesn’t actually work 😬
I think there’s a good argument for special-casing that though :thinking_face:
linking to cljdocs or similar instead for those would be excellent
@martinklepsch one more quick one - if you have a namespace required with an alias, is it possible to do something like [[v/kind]]
in the docs?
Or do we still need the qualified namespace
still need the qualified one
but you can just use the last segment of it
If I remember correctly vars in [[links]]
are resolved relative to the current ns
yup, that is right
hmm, one more note @martinklepsch, sorry to bug you:
I’m seeing this, but here it looks like the job’s succeeded? https://app.circleci.com/pipelines/github/cljdoc/builder/14939/workflows/890b5718-7489-48b8-8c81-47e41734de7a/jobs/31316
in fact, here all looks well
(is it possible to re-trigger the build, maybe, and have that solve the issue?)
@sritchie09 there is a very subtly hidden “rebuild” button that appears if you hover over it in the top right corner.