Fork me on GitHub
#off-topic
<
2018-04-19
>
xtreak2909:04:21

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.

xtreak2909:04:37

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

dominicm10:04:28

check the codox wiki, it has some steps for this iirc

xtreak2911:04:23

Thanks will check it out. I am currently using docs folder in master branch with the docs generated by codox.

Alex Miller (Clojure team)11:04:16

Github now supports just using a folder in your main branch instead of a gh-pages branch which is a lot easier

๐Ÿ™ 4
parrot 12
xtreak2911:04:06

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.

bja15:04:49

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

gonewest81815:04:24

@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

xtreak2903:04:48

Thanks a lot. Will check it.

dominicm15:04:12

@alexmiller That's amazing, I'd been putting off documenting my project, but I'm going to do it now ๐Ÿ˜ฎ

sophiago21:04:35

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

Alex Miller (Clojure team)21:04:19

ICFP has not yet finalized their pricing schedule so we have also not finalized the combined rate

Alex Miller (Clojure team)21:04:57

but it will probably be something like 75-80% of the cost of buying them individually

Alex Miller (Clojure team)21:04:21

and that will be available at the Strange Loop registration site (in June)

sophiago21:04:52

Awesome. I don't typically travel to confs so am hoping I can make all these at once this year ๐Ÿ™‚

Alex Miller (Clojure team)21:04:33

registration is always way more complicated to configure than you expect, even when you take that into account. This year, doubly so.

sophiago21:04:26

You mean more complicated for you and simpler for me, right? ๐Ÿ™‚

Alex Miller (Clojure team)21:04:37

afaict, it is not simpler for anyone :)

sophiago21:04:14

Well, compared to traveling to two venues

chad21:04:32

Putting forward a proposal to go to Strange Loop really looking forward to it. Long flight from New Zealand though!

Alex Miller (Clojure team)21:04:38

although we actually use two different buildings :)

Alex Miller (Clojure team)21:04:51

but we run continuous shuttles between them

sophiago21:04:31

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 ๐Ÿ˜›

Alex Miller (Clojure team)21:04:55

attending the full week will probably be pretty mind melting I expect

sophiago21:04:05

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

Alex Miller (Clojure team)21:04:34

although Iโ€™m looking forward to other people being as tired as I am :)

๐Ÿ˜„ 4
๐Ÿ˜ด 4
dpsutton21:04:43

@alexmiller that email you received recommending the speaker was from me

dpsutton21:04:49

(if you received it)

Alex Miller (Clojure team)21:04:00

I got it, havenโ€™t had a chance to reply yet, but thanks!

dpsutton21:04:17

figured. just putting on your radar

vemv23:04:30

I swear I prefer Github over Gitlab specifically b/c it's not a SPA

vemv23:04:10

SPAs can be so widgety. My eyes cannot be relaxed with excess animations