Scalaldoc

Scaladoc is a tool for generating API documentation from Scala source code.

YAML Configuration

scaladoc:

  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.75 CPU with 2880 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 another 240 MiB for JVM metaspace, and makes the rest of RAM available to JVM for heap allocation. For example, -Xmx2400m is specified by default (for 0.75 CPU), -Xmx5280m is specified for 1.5 CPU.

Examples

  • With scaladoc set to default

    docstand:
      scaladoc: default
    
  • With custom machine:

    docstand:
      scaladoc:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    

results matching ""

    No results matching ""