protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers.

YAML Configuration

protoc-gen-doc:

  • input:

    • Defaults to the repository root.
  • machine:

    • cpu:

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

  • options:

    Below is the supported option:

    -IPATH, --proto_path=PATH   Specify the directory in which to search for
                                imports.  May be specified multiple times;
                                directories will be searched in order.  If not
                                given, the current working directory is used.
                                If not found in any of the these directories,
                                the --descriptor_set_in descriptors will be
                                checked for required proto file.
    

Examples

  • With input option

    docstand:
      protoc-gen-doc:
        input:
          - src/
          - demos/
    
  • With custom machine:

    docstand:
      protoc-gen-doc:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With customized protoc-gen-doc

    docstand:
      protoc-gen-doc:
        options:
          -I: proto_lib
    

results matching ""

    No results matching ""