cljdoc

Sam Ritchie 2023-02-18T16:28:18.046999Z

@lee okay, another clerk-utils issue… https://app.circleci.com/pipelines/github/cljdoc/builder/40103/workflows/1a2aa813-9bef-494b-b3c0-33ec5aa86186/jobs/56477 the analyzer is looking for the user namespace… but I can’t see why it is doing that

Sam Ritchie 2023-02-20T16:45:14.480269Z

@lee we have liftoff! https://cljdoc.org/d/org.mentat/clerk-utils/0.4.1/api/mentat

lread 2023-02-20T16:47:22.685979Z

Sweet! Btw, I have not gotten a response from the author of flexmark-java yet about those ref links in images yet.... so they'll continue to render badly for the near term.

Sam Ritchie 2023-02-20T16:54:50.197929Z

no problem, thanks for checking in on that

Sam Ritchie 2023-02-19T15:24:28.227389Z

I took that approach, thanks all!

Sam Ritchie 2023-02-18T16:30:31.648299Z

oh… maybe this is what @seancorfield warned me against? is cljdoc parsing the clj files in my template ?

lread 2023-02-18T16:40:39.505829Z

Thanks for reporting @sritchie09! I'll take a peek sometime today.

Sam Ritchie 2023-02-18T16:46:14.057409Z

sounds good! I’ve also gone ahead and changed all of the clj and cljs extensions to tmpl, as @seancorfield suggested in #deps-new. that hopefully will get us set on the next release

Sam Ritchie 2023-02-18T16:51:43.088819Z

maybe something is strange though, since I don’t know if my hooks namespaces in resources get analyzed? https://github.com/mentat-collective/Clerk-Utils/blob/main/resources/clj-kondo.exports/org.mentat/clerk-utils/hooks/mentat/clerk_utils/viewers.clj like this will fail for sure, given my declared dependencies…

Sam Ritchie 2023-02-18T17:05:10.271919Z

I guess I can :no-doc the hooks namespaces? is that required?

lread 2023-02-18T17:24:26.250299Z

Yeah, namespaces with :no-doc are not explicitly loaded during analysis (but note, they can be implicitly loaded, by your other namespaces, probably not the case for you here though). :no-doc a good way to tell cljdoc (and codox for that matter) that a namespace should be excluded from your public API.

Sam Ritchie 2023-02-18T17:24:59.422019Z

Okay, that should cover it… and the tmpl change hopefully will fix the template getting pulled in

lread 2023-02-18T17:28:29.459479Z

It's currently a bit on the heavy side, but https://github.com/cljdoc/cljdoc/blob/master/doc/running-cljdoc-locally-author.adoc if you like.

👍 1
lread 2023-02-18T17:29:23.546309Z

Lemme me know if there is anything else to look into here, happy to help if there are still mysteries.

Sam Ritchie 2023-02-18T17:29:38.077189Z

Thank you’

Sam Ritchie 2023-02-18T17:29:39.423179Z

!

seancorfield 2023-02-19T00:33:14.511109Z

The hooks can have a .clj-kondo extension as I recall. Check next.jdbc (in at a cat show right now and can't check)

lread 2023-02-19T05:18:47.588419Z

Huh, forgot that @seancorfield, but yeah that is what I've done for hooks I've written: https://github.com/clj-commons/etaoin/tree/master/resources/clj-kondo.exports/etaoin/etaoin/etaoin

👍🏻 1