docs

About docs of Clojure & libs
pithyless 2018-01-25T11:37:43.000552Z

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

arrdem 2018-01-25T17:37:03.000344Z

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

arrdem 2018-01-25T17:38:23.000385Z

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

pithyless 2018-01-25T17:56:56.000891Z

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 🙂

arrdem 2018-01-25T18:05:42.000622Z

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.

timgilbert 2018-01-25T22:21:36.000132Z

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

timgilbert 2018-01-25T22:28:04.000347Z

Hmm, guess I can just automate this: https://github.com/weavejester/codox/wiki/Deploying-to-GitHub-Pages

martinklepsch 2018-01-25T22:48:38.000415Z

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

timgilbert 2018-01-25T22:49:50.000082Z

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

timgilbert 2018-01-25T22:50:06.000349Z

Trying to figure out a good documentation tool

timgilbert 2018-01-25T22:51:25.000164Z

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/

timgilbert 2018-01-25T22:52:12.000231Z

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

martinklepsch 2018-01-25T22:52:42.000182Z

Is your lib on Clojars + Github already?

timgilbert 2018-01-25T22:53:01.000105Z

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

martinklepsch 2018-01-25T22:54:05.000589Z

@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

timgilbert 2018-01-25T22:54:17.000411Z

Sounds great, I'll do that

timgilbert 2018-01-25T22:54:49.000120Z

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

arrdem 2018-01-25T22:55:01.000560Z

That’s the goal 😄

martinklepsch 2018-01-25T22:55:09.000219Z

I share that sentiment 😄

timgilbert 2018-01-25T22:55:25.000157Z

Sweet. Well, I'll keep you posted

martinklepsch 2018-01-25T22:55:43.000403Z

👍

arrdem 2018-01-25T22:55:51.000356Z

🦜

2