Skip to content

dumps

Create one markdown file per subcommand under --docsPath.

Existing pages may keep a narrative block between MANUAL DOCS START/END
HTML comments on their own lines; that block is preserved across
regenerations.

Usage

Usage: gitlab-compliance dumps [OPTIONS]

Options

  • base_module (REQUIRED):
  • Type: STRING
  • Default: src.gitlab_compliance
  • Usage: --baseModule

The base command module path to import

  • base_command (REQUIRED):
  • Type: STRING
  • Default: gitlab_compliance
  • Usage: --baseCommand

The base command function to import

  • docs_path (REQUIRED):
  • Type: STRING
  • Default: docs/usage/reference/
  • Usage: --docsPath

The docs dir path to write the md files

  • help:
  • Type: BOOL
  • Default: false
  • Usage: --help

Show this message and exit.

CLI Help

Usage: gitlab-compliance dumps [OPTIONS]

  Create one markdown file per subcommand under --docsPath.

  Existing pages may keep a narrative block between MANUAL DOCS START/END HTML
  comments on their own lines; that block is preserved across regenerations.

Options:
  --baseModule TEXT   The base command module path to import  [required]
  --baseCommand TEXT  The base command function to import  [required]
  --docsPath TEXT     The docs dir path to write the md files  [required]
  --help              Show this message and exit.