Fork me on GitHub
#clj-commons
<
2023-11-24
>
Eugen13:11:56

FYI I've added deps.edn support for metrics-clojure and took over this issue to prepare release https://github.com/clj-commons/metrics-clojure/issues/141 . IMO the first release should be just code migrated to clj-commons and deps.edn - no major code changes to metrics-clojure libraries

1
Eugen20:11:21

@seancorfield, @slipset: does clj-commons have a readthedocs account? Trying to publish docs for https://metrics-clojure.readthedocs.io/en/latest/# . We might use github pages but we should probably remove the project on read the docs. WDYT?

seancorfield21:11:07

My preference would be for each project to have a docs folder and rely on http://cljdoc.org for documentation. That said, Marginalia has docs that are rendered by marginalia itself so they're pure HTML and I've hosted those on the gh-pages branch so they show up under http://clj-commons.org for now. I have no idea about http://readthedocs.io tho', sorry.

lread21:11:17

@eugen.stan, if they are plain old docs suitable for cljdoc, I can give you a hand with any conversion and config. Lemme know.

Eugen23:11:44

@seancorfield: metrics-clojure has docs in ReStructured Text format - generates html, pdf,epub with Sphinx python tool. I don't plan to rewrite any time soon, use as is. I will ping one of the authors to see if they can transfer the readthedocs account as well.

seancorfield23:11:32

In the meantime, you could generate to HTML and put it on the gh-pages branch of the metrics-clojure repo, and then https://clj-commons.org/metrics-clojure/ will be the doc root?

Eugen00:11:53

yes, I could do that.

Eugen00:11:10

I will see about adding cljdoc suport as well in the future