Codox

A tool for generating API documentation from Clojure or ClojureScript source code.

YAML Configuration

codox:

  • config-file:

    • Path to project.clj or build.boot.
    • Based on whether the configuration file is project.clj or build.boot, Dostand uses Leiningen or Boot to build documentation.
    • If this field is omitted:
      • Docstand automatically searches for project.clj or build.boot under your repository and use it to build documentation.
      • In case when no configuration file has been found, Docstand generates default project.clj.
  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.5 CPU with 1920 MiB RAM.

      Docstand configures the maximum heap size (-Xmx) of the Java virtual machine (JVM) according to this value. Docstand reserves 240 MiB RAM for system, and makes the rest of RAM available to JVM for heap allocation. For example, -Xmx1680m is specified by default (for 0.5 CPU), -Xmx5520m is specified for 1.5 CPU.

  • options:

    Below is the supported option (available only for Leiningen project):

    with-profile: list of profiles.
    

Examples

  • With codox set to default

    docstand:
      codox: default
    
  • With custom machine:

    docstand:
      codox:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With config-file option

    docstand:
      codox:
        config-file: project.clj
    
  • With with-profile option

    docstand:
      codox:
        options:
          with-profile: [profile1, profile2]
    

results matching ""

    No results matching ""