docs/api.lisp @ 6d74e7ab0fc0

Hacky documentation updates
author Steve Losh <steve@stevelosh.com>
date Fri, 28 Aug 2020 00:24:06 -0400
parents a2712b3d3b16
children 700d5c649245
(ql:quickload "cl-d-api")

(defparameter *header*
  "The following is a list of all user-facing parts of Jarl.

If there are backwards-incompatible changes to anything listed here, they will
be noted in the changelog and the author will feel bad.

Anything not listed here is subject to change at any time with no warning, so
don't touch it.

")

(d-api:generate-documentation
  :jarl
  #p"docs/02-reference.markdown"
  (list "JARL")
  *header*
  :title "API Reference")

(d-api:draw-class-hierarchy
  "docs/static/errors.svg"
  '(jarl::json-error
    jarl::json-parsing-error
    jarl::json-limit-exceeded-error
    jarl::json-size-limit-exceeded-error
    jarl::json-depth-limit-exceeded-error)
  :abstract-classes
  '(jarl::json-error
    jarl::json-limit-exceeded-error))