Clojure: Marginalia: Multi Page Documentation

Question

Question

(run-marginalia {})

produces a single file, docs/uberdoc.html

I would prefer it to produce many files in docs/*, one per *.clj file

Motivation:

I really like marginalia. I have recently started using it, and it's causing me to want to write documentation, as impossible as that sounds.

However, I have this problem that whenever I write docs, and refresh, and reload uberdoc.html, I lose the part of the doc I was previously looking at. Thus, I would prefer a system where each *.clj file had it's on *.html file for documentation. Is this possible with marginalia 0.7.0?

Thanks!

score 1 · Accepted Answer · answered Jun 07 '12 at 13:01

1

There was a mutlidoc functionality in a previous version, but it is not at command line in the latest version. However, by running something like (multidoc! "./docs" (find-processable-file-paths "./src" #"\.clj$") {}) you should get directory of individual files.

answered Jun 07 '12 at 13:01

Eli Schneider

4,903
3
28
50

1

The latest version of Marginalia (0.7.1) takes a `--multi` flag that basically runs this function. More info at http://blog.fogus.me/2012/06/08/announcing-marginalia-v0-7-1/ – fogus Jun 14 '12 at 18:17

score 0 · Answer 2 · edited Jun 07 '12 at 16:46

0

https://github.com/weavejester/codox is another Clojure documentation tool (which gives separate pages - see http://number23.github.com/commons-lib/)

edited Jun 07 '12 at 16:46

andrew cooke

45,717
10
93
143

answered Jun 07 '12 at 02:22

number23_cn

4,611
26
31

is there an example somewhere? i couldn't see one at the link. – andrew cooke Jun 07 '12 at 15:42
1

add to project.clj's `:plugins` like this: https://github.com/number23/commons-lib/blob/master/project.clj, output docs: http://number23.github.com/commons-lib/ – number23_cn Jun 07 '12 at 16:39

Clojure: Marginalia: Multi Page Documentation

Question

Motivation:

2 Answers2