This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2022-05-06
Channels
- # announcements (7)
- # aws (8)
- # babashka (9)
- # babashka-sci-dev (11)
- # beginners (37)
- # calva (50)
- # cider (15)
- # clj-kondo (30)
- # clj-otel (3)
- # cljdoc (16)
- # cljs-dev (26)
- # cljsrn (4)
- # clojure (168)
- # clojure-doc (1)
- # clojure-europe (17)
- # clojure-gamedev (4)
- # clojure-nl (3)
- # clojure-norway (1)
- # clojure-spec (17)
- # clojure-uk (16)
- # clojurescript (27)
- # community-development (3)
- # css (3)
- # cursive (9)
- # datomic (25)
- # emacs (1)
- # events (4)
- # fulcro (2)
- # google-cloud (2)
- # graphql (11)
- # gratitude (9)
- # humbleui (16)
- # hyperfiddle (2)
- # jobs (1)
- # london-clojurians (1)
- # lsp (16)
- # malli (2)
- # off-topic (71)
- # pedestal (4)
- # polylith (9)
- # portal (94)
- # reagent (6)
- # reitit (2)
- # releases (1)
- # remote-jobs (2)
- # sci (9)
- # shadow-cljs (49)
- # spacemacs (8)
- # tools-build (2)
- # tools-deps (39)
- # vim (7)
- # xtdb (6)
dev warning: might be a few circleci build failures as I work out some kinks in some ci rework
Is there doc on how to run cljdoc for a private (commercial) project? e.g. run it in CI and create an artifact to be uploaded elsewhere. Similar to "coverage" and "junit" tools
Hiya @vemv, are you looking to run the cljdoc web site? Or do you just want to generate the library analysis edn?
I reckon that I want to generate the "cljdoc web site", but only for the project in question
What would the behavior be if I visited /
?
Hmm…. so currently cljdoc analyzes a library, saves the result in a database and then the web site dynamically renders from data stored in that database.
Tools like https://github.com/weavejester/codox (used by many), https://tomfaulhaber.github.io/autodoc (used by Clojure core team), and the new https://github.com/borkdude/quickdoc (something new from borkdude!) all generate static API docs. Would they be options?
I'm aware of them, but also IDK :) Does cljdoc have internal magic sauce that would make the results more accurate than e.g. codox?
The https://github.com/cljdoc/cljdoc-analyzer is a fork of codox. They are pretty similar. Both do load-time analysis to glean public APIs. We currently do a little more (last time I checked) around discovering dynamically created vars for ClojureScript analysis.
https://github.com/weavejester/codox/commits/master seems pretty sparse
Load-time analysis is great in that it will discover everything, but can also be problematic (I mean everything has to actually load correctly). I am currently looking at also supporting static analysis for cljdoc (via clj-kondo data analysis which is what quickdoc uses). But that’s tangental… and not what you were asking about.
I really appreciate load-time analysis so yeah I don't know where to take it from here... looks like the ingredients I want are there but not integrated ootb currently