apiDoc

RESTful web API Documentation Generator.

YAML Configuration

apidoc:

  • config-file

    • Path to the apiDoc configuration file (apidoc.json).
    • If this field is omitted, Docstand searches for apidoc.json under the repository and uses it to build documentation.
  • machine:

    • cpu:

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

  • options:

    Below is the list of supported options:

     -f, --file-filters      RegEx-Filter to select files that should be parsed (multiple -f can be used).
                             [.*\.(clj|cls|coffee|cpp|cs|dart|erl|exs?|go|groovy|ino?|java|js|jsx|kt|litcoffee|lua|p|php?|pl|pm|py|rb|scala|ts|vue)$]
     -e, --exclude-filters   RegEx-Filter to select files / dirs that should not be parsed (many -e can be used).  []
     -i, --input             Input / source dirname.  [./]
     -t, --template          Use template for output files.  [/usr/local/lib/node_modules/apidoc/template/]
     -p, --private           Include private APIs in output.  [false]
     --debug                 Show debug messages.  [false]
     --color                 Turn off log color.  [true]
     --parse-filters         Optional user defined filters. Format name=filename
     --parse-languages       Optional user defined languages. Format name=filename
     --parse-parsers         Optional user defined parsers. Format name=filename
     --parse-workers         Optional user defined workers. Format name=filename
     --markdown              Turn off default markdown parser or set a file to a custom parser.  [true]
     --line-ending           Turn off autodetect line-ending. Allowed values: LF, CR, CRLF.
     --encoding              Set the encoding of the source code. [utf8].  [utf8]
    

Examples

  • With apidoc set to default

    docstand:
      apidoc: default
    
  • With custom machine:

    docstand:
      apidoc:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With customized apidoc

    docstand:
      apidoc:
        options:
          --input: src/
          --private:
    

results matching ""

    No results matching ""