mkdocs/build
¶
Configure jobs to build the MkDocs static site for this project.
Usage¶
include:
- component: git.ligo.org/computing/gitlab/components/mkdocs/build@<VERSION>
inputs:
stage: build
Inputs¶
Input | Default value | Description |
---|---|---|
project_dir |
"." |
Directory containing the mkdocs.yml file |
stage |
"test" |
Pipeline stage to add jobs to |
requirements |
"" |
Extra requirements to install with pip [Tip: pass requirements: -r requirements.txt to install from a requirements file] |
mkdocs_options |
"--clean --verbose" |
Options to pass to mkdocs build |