Liking cljdoc? Tell your friends :D

scicloj.clay.v2.make


->single-ns-specclj

(->single-ns-spec spec config source-path)
source

clay-render-notebookclj

(clay-render-notebook
  notes
  {:as spec :keys [format full-target-path qmd-target-path book post-process]})
source

extract-specsclj

(extract-specs config spec)
source

handle-single-source-spec!clj

(handle-single-source-spec!
  {:as spec
   :keys [source-paths source-type single-form single-value full-source-path
          full-target-path qmd-target-path use-kindly-render keep-existing
          external-requirements]})
source

index-target-path?clj

(index-target-path? path)
source

kindly-render-notebookclj

(kindly-render-notebook notes {:as spec :keys [full-target-path]})
source

make!clj

(make! spec)
source

make-book!clj

(make-book! {:as spec :keys [base-target-path run-quarto show]})
source

maybe-run-quarto!clj

(maybe-run-quarto! {:as spec :keys [book run-quarto qmd-target-path format]})
source

maybe-user-hookclj

(maybe-user-hook {:as spec :keys [config/transform]})
source

merge-ns-configclj

(merge-ns-config spec)
source

quarto-book-indexclj

(quarto-book-index {{:keys [toc title]} :book})
source

quarto-render!clj

(quarto-render! {:as spec
                 :keys [base-target-path quarto-target-path qmd-target-path
                        post-process full-target-path book]})
source

relative-source-pathclj

(relative-source-path {:as spec :keys [source-path base-source-path ns-form]})

Returns the source-path relative to the base-source-path, which is used to calculate the target path.

Returns the source-path relative to the base-source-path,
which is used to calculate the target path.
sourceraw docstring

spec->full-source-pathclj

(spec->full-source-path {:as spec :keys [base-source-path source-path]})

Returns the source-path relative to the current working directory (project root). This may be the base-source-path + the source-path when both are relative, or if source-path is absolute will be relativized without regard to a base-source-path. full-source-path needs to be relative to calculate git links.

Returns the source-path relative to the current working directory (project root).
This may be the base-source-path + the source-path when both are relative,
or if source-path is absolute will be relativized without regard to a base-source-path.
full-source-path needs to be relative to calculate git links.
sourceraw docstring

spec->full-target-pathclj

(spec->full-target-path {:as spec
                         :keys [source-path source-paths full-source-path
                                source-type base-target-path flatten-targets
                                format keep-sync-root book first-as-index]})

Returns the target-path relative to the current working directory (project root).

Returns the target-path relative to the current working directory (project root).
sourceraw docstring

spec->ns-configclj

(spec->ns-config {:keys [ns-form]})
source

spec->ns-formclj

(spec->ns-form {:keys [source-type full-source-path]})
source

spec->qmd-target-pathclj

(spec->qmd-target-path {:as spec
                        :keys [format base-target-path full-target-path
                               quarto-target-path]})
source

spec->quarto-book-chapters-configclj

(spec->quarto-book-chapters-config {:keys [base-target-path full-target-paths
                                           full-target-paths-w-book-struct]})
source

spec->quarto-book-configclj

(spec->quarto-book-config {:as spec :keys [book quarto]})
source

spec->source-typeclj

(spec->source-type {:keys [source-path]})
source

sync-resources!clj

(sync-resources! {:keys [base-target-path quarto-target-path subdirs-to-sync
                         keep-sync-root]})
source

tempory-target?clj

(tempory-target? {:keys [single-form single-value]})
source

write-quarto-book-config!clj

(write-quarto-book-config! quarto-book-config {:keys [base-target-path]})
source

write-quarto-book-index-if-needed!clj

(write-quarto-book-index-if-needed! quarto-index {:keys [base-target-path]})
source

write-test-forms-as-nsclj

(write-test-forms-as-ns forms)
source

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