Fork me on GitHub
#cljdoc
<
2020-12-20
>
dharrigan15:12:28

I'm obviously doing something wrong. I'm trying to "preview" documentation for a library. Following the instructions on the webpage, I've cloned the repo, and I'm executing this command within the project (library) directory...

dharrigan15:12:02

../cljdoc/script/cljdoc ingest --project io.sentry/sentry-clj --version 1.1.136 --git $(pwd) --rev $(git rev-parse HEAD)

dharrigan15:12:18

No matter what I try to do, I keep getting this error:

dharrigan15:12:27

** ERROR: **
Exception: #error {
 :cause Requested version cannot be found in configured repositories: [io.sentry/sentry-clj 1.1.136]
 :data {:project io.sentry/sentry-clj, :version 1.1.136}
 :via
 [{:type clojure.lang.ExceptionInfo
   :message Requested version cannot be found in configured repositories: [io.sentry/sentry-clj 1.1.136]
   :data {:project io.sentry/sentry-clj, :version 1.1.136}
   :at [cljdoc.util.repositories$artifact_uris invokeStatic repositories.clj 119]}]
 :trace
 [[cljdoc.util.repositories$artifact_uris invokeStatic repositories.clj 119]

dharrigan15:12:54

Right figured it out.

dharrigan15:12:40

I have to deploy it to my local m2 first. I guess, there's no way for it to simply scan the local src directory and not rely upon deployments?

lread17:12:48

Hiya @dharrigan! Glad you got sorted out. > I guess, there’s no way for it to simply scan the local src directory and not rely upon deployments? We could probably make this work, but right now we are simply reusing cljdoc production behaviours. Keeping the number of variables down has its advantages. But I do see your point, I was just doing a local preview yesterday, and it is on the heavy and slow side. I find a script helps, here’s https://github.com/lread/rewrite-cljc-playground/blob/master/script/cljdoc_preview.clj.

dharrigan18:12:51

thank you lee, will try 🙂

seancorfield23:12:48

Just a quick sanity check: I know that ^:no-doc on an ns form will tell cljdoc to ignore it. Does that work on an individual def/`defn` basis as well or should I use something else to exclude a (public) function from the docs?

seancorfield18:12:24

I should just RTFM 🙂

martinklepsch18:12:34

no worries 😄