cljdoc

https://cljdoc.org/ & https://github.com/cljdoc/cljdoc
lread 2021-02-08T00:03:57.006300Z

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

👌 1
Sam Ritchie 2021-02-08T00:16:41.006700Z

got it!

Sam Ritchie 2021-02-08T00:17:18.007400Z

good to know that the base thing we want is that docs should also be just as readable from the github source tree

Sam Ritchie 2021-02-08T00:17:53.008300Z

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

Sam Ritchie 2021-02-08T14:53:37.008800Z

hey all, one Q - what’s the style for linking to clojure.core functions?

Sam Ritchie 2021-02-08T14:54:03.009500Z

[[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

Sam Ritchie 2021-02-08T14:54:15.010100Z

in this docstring

martinklepsch 2021-02-08T15:00:26.011100Z

@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 😬

martinklepsch 2021-02-08T15:03:10.011900Z

I think there’s a good argument for special-casing that though :thinking_face:

Sam Ritchie 2021-02-08T15:16:40.012200Z

linking to cljdocs or similar instead for those would be excellent

Sam Ritchie 2021-02-08T15:40:45.013Z

@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?

Sam Ritchie 2021-02-08T15:40:54.013300Z

Or do we still need the qualified namespace

martinklepsch 2021-02-08T15:44:44.013400Z

still need the qualified one

martinklepsch 2021-02-08T15:44:53.013500Z

but you can just use the last segment of it

martinklepsch 2021-02-08T15:45:17.013600Z

If I remember correctly vars in [[links]] are resolved relative to the current ns

Sam Ritchie 2021-02-08T15:54:21.013800Z

yup, that is right

Sam Ritchie 2021-02-08T18:49:13.014100Z

hmm, one more note @martinklepsch, sorry to bug you:

Sam Ritchie 2021-02-08T18:49:16.014300Z

Sam Ritchie 2021-02-08T18:49:56.014900Z

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

Sam Ritchie 2021-02-08T18:51:57.015100Z

Sam Ritchie 2021-02-08T18:52:00.015500Z

in fact, here all looks well

Sam Ritchie 2021-02-08T19:04:34.015800Z

(is it possible to re-trigger the build, maybe, and have that solve the issue?)

lread 2021-02-08T19:17:52.016700Z

@sritchie09 there is a very subtly hidden “rebuild” button that appears if you hover over it in the top right corner.