So, I started working on docup[1], which currently is just for fun,
but my intentions are to find some subset of rules for what we've
discussed in this thread that would be appropriate for autodoc's
markup. It doesn't currently support much at all, but to eliminate
gobbledegook, there's no nesting of simple element types (bold,
italic, underline, inline code). The plan is to support images, lists,
links (by recognizing some common raw URLs), blocks, and eventually
equations (though I'm not convinced they can be simplified for REPL
documentation). For images/figures, the current plan is to use the
footnote approach as discussed previously, but, rearrange the syntax
to eliminate the excess noise:
![caption][ref label] => [ref label: caption]
There would be no supported way to inline the reference for the
image--again, the goal as Tom reiterated originally is to eliminate
excess junk.
[1]: http://github.com/apgwoz/clj-docup
On Tue, Oct 26, 2010 at 6:21 PM, Chris Maier
<[email protected]> wrote:
>> On Tue, Oct 26, 2010 at 4:44 PM, Timo Mihaljov <[email protected]> wrote:
>>> If you wanted to get real fancy, you could even check if the code
>>> block is a list, and then resolve each symbol inside the list, so
>>> that, for example, resolve's docstring would look like this at the
>>> REPL:
>>>
>>> user=> (doc resolve)
>>> -------------------------
>>> clojure.core/resolve
>>> ([sym])
>>> same as `(ns-resolve *ns* sym)`
>>>
>>> But in the HTML documentation `ns-resolve` and `*ns*` would be
>>> hyperlinks.
>
> That is slick.
>
> If there's any way I can help out, too, sign me up.
>
> Chris
>
> --
> You received this message because you are subscribed to the Google
> Groups "Clojure" group.
> To post to this group, send email to [email protected]
> Note that posts from new members are moderated - please be patient with your
> first post.
> To unsubscribe from this group, send email to
> [email protected]
> For more options, visit this group at
> http://groups.google.com/group/clojure?hl=en
--
http://www.apgwoz.com
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to [email protected]
Note that posts from new members are moderated - please be patient with your
first post.
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
