Liking cljdoc? Tell your friends :D

kaocha.plugin.scenari-doc

--doc-html FILE: the HTML documentation of the selected scenarios.

One document: a clickable table of contents, one section per feature, one anchor per scenario. It is written from the test-plan, so after the filters - what would have run is exactly what gets documented. For that the plugin must come after :kaocha.plugin/scenari-tags in :kaocha/plugins; kaocha's own filters (--focus, --skip-meta) always run first.

Nothing is executed: this is static documentation, not a run report. The suites are marked ::testable/skip once the file is written.

--doc-report FILE writes the same document after the run, annotated with each scenario's and step's result.

`--doc-html FILE`: the HTML documentation of the selected scenarios.

One document: a clickable table of contents, one section per feature, one
anchor per scenario. It is written from the test-plan, so *after* the filters -
what would have run is exactly what gets documented. For that the plugin must
come after `:kaocha.plugin/scenari-tags` in `:kaocha/plugins`; kaocha's own
filters (`--focus`, `--skip-meta`) always run first.

Nothing is executed: this is static documentation, not a run report. The
suites are marked `::testable/skip` once the file is written.

`--doc-report FILE` writes the same document after the run, annotated with
each scenario's and step's result.
raw docstring

documentclj

(document features)
source

scenari-doc-cli-options-hookclj

(scenari-doc-cli-options-hook opts)
source

scenari-doc-config-hookclj

(scenari-doc-config-hook config)
source

scenari-doc-hooksclj

source

scenari-doc-post-load-hookclj

(scenari-doc-post-load-hook test-plan)
source

scenari-doc-post-run-hookclj

(scenari-doc-post-run-hook result)
source

scenari-doc-pre-load-hookclj

(scenari-doc-pre-load-hook config)
source

selected-featuresclj

(selected-features tree)

The scenari features kept by the filters, each with its kept scenarios under ::scenarios.

The scenari features kept by the filters, each with its kept scenarios under
`::scenarios`.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close