fnhouse.docs — prismatic/fnhouse 0.2.1

Proof-of-concept, ultra-primitive HTML doc generation from a fnhouse API spec, including schemas and per-namespace handler doc pages.

$:page$GET clj

Generate HTML for docs, given the output of all-docs as :api-docs resource

all-docs clj

(all-docs handler-infos)

Inputs: [handler-infos :- [schemas/HandlerInfo]]

Generate HTML for handlers and schemas from a sequence of HandlerInfo descriptions.

dirty-hack clj

(dirty-hack s)

Replace linked schemas in the HTML output with links to the corresponding schemas.

emit-attribute clj

(emit-attribute k v)

emit-attributes clj

(emit-attributes attr)

emit-close-tag clj

(emit-close-tag t)

emit-open-tag clj

(emit-open-tag tag)

(emit-open-tag tag attr)

extract-schemas clj

(extract-schemas schemas-atom form)

Extract schemas, replacing defschemas with references to name to be replace with links using dirty-hack below.

generate-docs clj

(generate-docs schemas-atom handler-infos)

pprint-str clj

(pprint-str x)

render clj

(render & forms)

render-helper clj

(render-helper form)

style clj

(style m)

walk clj

(walk inner outer form)

A version of clojure.walk/walk, extended to work on records.

write-docs! clj

(write-docs! handler-infos output-dir)

Inputs: [handler-infos :- [schemas/HandlerInfo] output-dir :- String]

Write handlers.html and schemas.html to output-dir from sequence of HanderInfo descriptions.