Fork me on GitHub
#docs
<
2018-01-25
>
pithyless11:01:43

@arrdem - are you planning on releasing a version of stacks to clojars? I’ve started playing with it locally on a project, but it would be good to know if I can expect to add it as a dev dependency to projects anytime soon.

arrdem17:01:03

@pithyless the precise status of stacks is unclear. As far as I’m concerned it’s a bunch of prototype code with no UI that also doesn’t have a storage model yet. @martinklepsch is working with me to try and sketch out a Grimoire v2 store system for his #cljdoc project. I don’t expect to do a release of stacks as I envision it until I get the lib-grimoire v2 store out the door and some of it may just get rolled into cljdoc. If it’d be useful to you for doctests or what have you I’d be happy to do a release as-is.

arrdem17:01:23

Sadly work has other higher priority needs so this has all taken a back seat.

pithyless17:01:56

That’s fine @arrdem, thanks for the status update. You’re right, I was mainly interested in the doctest stuff right now, but I can easily pull that out if necessary. I’m still trying to figure out, if it’s a good idea; so no need to commit to anything and release now. I’ve been playing with doctests and more specs (instrumented with orchestra), but I’m not sure myself if the ratio of code-to-docs in one place is helping or hurting comprehension 🙂

arrdem18:01:42

Yeah I’m pretty up in the air on the doctests thing myself. For some of the stuff I’ve written it’s pretty nice and I like that it lets me mechanically extract structure from docstrings but I can definitely see how it could be abused.

timgilbert22:01:36

Anyone have an example of having circleci auto-generate codox and push to a github pages branch?I did see https://github.com/clojure-tw/example-codox-circleci but it looks a bit out of date

martinklepsch22:01:38

@timgilbert what library are you wanting to publish docs for? I’m working on a thing that does all the docs building &publishing for you...

timgilbert22:01:50

I'm excited about your project @martinklepsch! I'm working on a soon-to-be open source library

timgilbert22:01:06

Trying to figure out a good documentation tool

timgilbert22:01:25

The thing I've got interops with lacinia, so I've been considering following their lead and publishing to http://readthedocs.org: http://lacinia.readthedocs.io/en/latest/

timgilbert22:01:12

But it's early days so I'm just sticking with a bunch of .md files and codox for the moment

martinklepsch22:01:42

Is your lib on Clojars + Github already?

timgilbert22:01:01

Nope, won't be for another few weeks it looks like, lot of bugs to hammer out

martinklepsch22:01:05

@timgilbert alright, let me know once release is imminent and we can sync up/I can show you what things would look like with the tool I’m working on

timgilbert22:01:17

Sounds great, I'll do that

timgilbert22:01:49

I've been dabbling in Elixir and having a http://hexdocs.pm for Clojure would be incredibly cool

arrdem22:01:01

That’s the goal 😄

martinklepsch22:01:09

I share that sentiment 😄

timgilbert22:01:25

Sweet. Well, I'll keep you posted