Search code examples
fantom

How to generate locally the documentation for an imported pod

The script buildwebdocs.fan generates the documentation for the distribution's pods, but not for the pods I did myself or imported. How can I generate the documentation locally for this pods?

Solution

  • You can invoke compilerDoc yourself:

    $ fan compilerDoc -?

Usage:
  compilerDoc [options] <pods>*
Arguments:
  pods    Name of pods to compile (does not update index)
Options:
  -help, -?         Print usage help
  -all              Generate docs for every installed pods
  -allCore          Generation docs for Fantom core pods
  -clean            Delete outDir
  -outDir <File>    Output dir for doc files

    So for you local pod:

    $ fan compilerDoc myPod