Liking cljdoc? Tell your friends :D
Clojure only.

automaton-build.tasks.docs

Publish documentation.

Proxy to codox.

Publish documentation.

Proxy to [codox](https://github.com/weavejester/codox?tab=readme-ov-file).
raw docstring

argumentsclj

cli-optsclj

cli-opts-monorepoclj

run-appclj

(run-app resource-filters doc-branch)

Entry point for running the documentation of the current application of the repl.

  • The resource-filters are used to find what images to copy to the website.

Gather data from:

  • The project-config is used to retrieve the app-name and the repo-url and base-branch.
  • The doc-paths is coming from the deps.edn codox alias.
  • Push the modifications to doc-branch
Entry point for running the documentation of the current application of the repl.

* The `resource-filters` are used to find what images to copy to the website.

Gather data from:

* The `project-config` is used to retrieve the `app-name` and the `repo-url` and `base-branch`.
* The  `doc-paths` is coming from the `deps.edn` codox alias.
* Push the modifications to `doc-branch`
raw docstring

run-monorepoclj

(run-monorepo resource-filters doc-branch)

Generates the documentation of one application in the monorepo.

  • The resource-filters are used to find what images to copy to the website.

Gather data from:

  • The project-config is used to retrieve the app-name and the repo-url and base-branch.
  • The doc-paths is coming from the deps.edn codox alias.
  • Push the modifications to doc-branch.
Generates the documentation of one application in the monorepo.

* The `resource-filters` are used to find what images to copy to the website.

Gather data from:

* The `project-config` is used to retrieve the `app-name` and the `repo-url` and `base-branch`.
* The  `doc-paths` is coming from the `deps.edn` codox alias.
* Push the modifications to `doc-branch`.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcutsReport a problemcljdoc on GitHub
× close