This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2018-04-19
Channels
- # aws-lambda (4)
- # beginners (62)
- # cider (20)
- # cljs-dev (9)
- # cljsrn (13)
- # clojars (3)
- # clojure (105)
- # clojure-brasil (1)
- # clojure-denver (1)
- # clojure-finland (4)
- # clojure-italy (23)
- # clojure-norway (1)
- # clojure-spec (6)
- # clojure-uk (56)
- # clojurescript (41)
- # cursive (10)
- # datomic (25)
- # emacs (23)
- # figwheel (2)
- # fulcro (133)
- # graphql (12)
- # hoplon (32)
- # instaparse (13)
- # keechma (1)
- # lein-figwheel (1)
- # luminus (1)
- # lumo (1)
- # nyc (2)
- # off-topic (34)
- # om (2)
- # onyx (10)
- # pedestal (8)
- # portkey (1)
- # re-frame (10)
- # reagent (26)
- # ring (8)
- # shadow-cljs (77)
- # spacemacs (4)
- # sql (8)
- # tools-deps (15)
- # vim (9)
How do clojure projects maintain docs with GitHub pages? I can see an example where you can run lein codox
and get the output to gh-pages
branch. But I don't know how to maintain the gh-pages branch such that I can run lein codox on master and it outputs to gh-pages. Maybe I am missing some git trick here.
I could see something with orphan branches : https://help.github.com/articles/creating-project-pages-using-the-command-line/ but it manually creates index.html
Thanks will check it out. I am currently using docs folder in master branch with the docs generated by codox.
Github now supports just using a folder in your main branch instead of a gh-pages branch which is a lot easier
Thanks I am using it now. They support the docs
folder in master. I just felt updating docs will pollute the master branch with diffs that I don't want to keep in master.
@xtreak I've managed this with a bit of shell scripting in the past on my CI server. One of the build steps was to run lein codox (or whatever tool) to generate the docs, then copy that into a tmp folder, switch branches, cp back to the repo now that branches are switched, and then push the branch, before checking back out whatever sha was being built.
@xtreak29 autodoc
is a script that manages the gh-pages
branch for you. It can be used manually or in your build automation. For instance weโre calling autodoc from Travis CI to auto-publish developer docs for clojure-emacs/orchard
. See here โ https://github.com/plexus/autodoc
@alexmiller That's amazing, I'd been putting off documenting my project, but I'm going to do it now ๐ฎ
@alexmiller re: Strange Loop, I heard there might be a bundled ticket with ICFP and everything else colocated this year. Do you know anything about that yet? It's pretty early, I suppose.
yes, there will be
ICFP has not yet finalized their pricing schedule so we have also not finalized the combined rate
but it will probably be something like 75-80% of the cost of buying them individually
and that will be available at the Strange Loop registration site (in June)
Awesome. I don't typically travel to confs so am hoping I can make all these at once this year ๐
registration is always way more complicated to configure than you expect, even when you take that into account. This year, doubly so.
afaict, it is not simpler for anyone :)
that part, yes :)
Putting forward a proposal to go to Strange Loop really looking forward to it. Long flight from New Zealand though!
although we actually use two different buildings :)
but we run continuous shuttles between them
Yeah, I assumed there'd be that whole issue. I'm a native New Yorker so just the prospect of driving is like being on a space shuttle ๐
attending the full week will probably be pretty mind melting I expect
That is a good point. Work aside, it's just draining by that point. Like how you don't stay in Las Vegas for more than a long weekend...
although Iโm looking forward to other people being as tired as I am :)
@alexmiller that email you received recommending the speaker was from me
I got it, havenโt had a chance to reply yet, but thanks!