diff --git a/docs/reference/global-options.mdx b/docs/reference/global-options.mdx index 8885a6992..db2303591 100644 --- a/docs/reference/global-options.mdx +++ b/docs/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/check.mdx b/docs/reference/goals/check.mdx index 055b4584b..d2b292a1c 100644 --- a/docs/reference/goals/check.mdx +++ b/docs/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/count-loc.mdx b/docs/reference/goals/count-loc.mdx index 4fc845fc8..a16c906d6 100644 --- a/docs/reference/goals/count-loc.mdx +++ b/docs/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/dependees.mdx b/docs/reference/goals/dependees.mdx index c8d158961..4033c80d2 100644 --- a/docs/reference/goals/dependees.mdx +++ b/docs/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/dependencies.mdx b/docs/reference/goals/dependencies.mdx index eecf7ea2a..4d03fb731 100644 --- a/docs/reference/goals/dependencies.mdx +++ b/docs/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/dependents.mdx b/docs/reference/goals/dependents.mdx index d8f395668..6727ab393 100644 --- a/docs/reference/goals/dependents.mdx +++ b/docs/reference/goals/dependents.mdx @@ -1,5 +1,7 @@ --- title: dependents +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/experimental-bsp.mdx b/docs/reference/goals/experimental-bsp.mdx index 6ffa7f417..fcc748c92 100644 --- a/docs/reference/goals/experimental-bsp.mdx +++ b/docs/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/experimental-deploy.mdx b/docs/reference/goals/experimental-deploy.mdx index cedddbdf4..f437c6091 100644 --- a/docs/reference/goals/experimental-deploy.mdx +++ b/docs/reference/goals/experimental-deploy.mdx @@ -1,5 +1,7 @@ --- title: experimental-deploy +description: | + Perform a deployment process. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/experimental-explorer.mdx b/docs/reference/goals/experimental-explorer.mdx index eb5e42352..7df90e7dc 100644 --- a/docs/reference/goals/experimental-explorer.mdx +++ b/docs/reference/goals/experimental-explorer.mdx @@ -1,5 +1,7 @@ --- title: experimental-explorer +description: | + Run the Pants Explorer Web UI server. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/export-codegen.mdx b/docs/reference/goals/export-codegen.mdx index 08f5cb08d..5ba91e387 100644 --- a/docs/reference/goals/export-codegen.mdx +++ b/docs/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/export.mdx b/docs/reference/goals/export.mdx index a29938189..2e997dc75 100644 --- a/docs/reference/goals/export.mdx +++ b/docs/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/filedeps.mdx b/docs/reference/goals/filedeps.mdx index fadeb17a0..ea3763879 100644 --- a/docs/reference/goals/filedeps.mdx +++ b/docs/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/fix.mdx b/docs/reference/goals/fix.mdx index e06700269..46c842554 100644 --- a/docs/reference/goals/fix.mdx +++ b/docs/reference/goals/fix.mdx @@ -1,5 +1,7 @@ --- title: fix +description: | + Autofix source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/fmt.mdx b/docs/reference/goals/fmt.mdx index d9fa4f94b..35b8eef6b 100644 --- a/docs/reference/goals/fmt.mdx +++ b/docs/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/generate-lockfiles.mdx b/docs/reference/goals/generate-lockfiles.mdx index 823ef51d6..d4bf5064f 100644 --- a/docs/reference/goals/generate-lockfiles.mdx +++ b/docs/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/generate-snapshots.mdx b/docs/reference/goals/generate-snapshots.mdx index d10694ebc..5eb68d024 100644 --- a/docs/reference/goals/generate-snapshots.mdx +++ b/docs/reference/goals/generate-snapshots.mdx @@ -1,5 +1,7 @@ --- title: generate-snapshots +description: | + Generate test snapshots. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/go-generate.mdx b/docs/reference/goals/go-generate.mdx index 68d198bbe..452041d13 100644 --- a/docs/reference/goals/go-generate.mdx +++ b/docs/reference/goals/go-generate.mdx @@ -1,5 +1,7 @@ --- title: go-generate +description: | + Run each command in a package described by a `//go:generate` directive. This is equivalent to running `go generate` on a Go package. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/help-advanced.mdx b/docs/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/docs/reference/goals/help-advanced.mdx +++ b/docs/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/help-all.mdx b/docs/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/docs/reference/goals/help-all.mdx +++ b/docs/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/help.mdx b/docs/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/docs/reference/goals/help.mdx +++ b/docs/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/lint.mdx b/docs/reference/goals/lint.mdx index 47aee7528..d33ccb3e6 100644 --- a/docs/reference/goals/lint.mdx +++ b/docs/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run linters/formatters/fixers in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/list.mdx b/docs/reference/goals/list.mdx index 78d49bb55..bc858f973 100644 --- a/docs/reference/goals/list.mdx +++ b/docs/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/package.mdx b/docs/reference/goals/package.mdx index 357be63d3..e6cb234d7 100644 --- a/docs/reference/goals/package.mdx +++ b/docs/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/paths.mdx b/docs/reference/goals/paths.mdx index 6ada5cf63..a2910f8b2 100644 --- a/docs/reference/goals/paths.mdx +++ b/docs/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. Either address may represent a group of targets, e.g. `--from=src/app/main.py --to=src/library::`. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/peek.mdx b/docs/reference/goals/peek.mdx index f42185cf3..4c54e6307 100644 --- a/docs/reference/goals/peek.mdx +++ b/docs/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/publish.mdx b/docs/reference/goals/publish.mdx index b6e9c59c8..2a90b4bd6 100644 --- a/docs/reference/goals/publish.mdx +++ b/docs/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/py-constraints.mdx b/docs/reference/goals/py-constraints.mdx index 21a5bf3a8..7c779befd 100644 --- a/docs/reference/goals/py-constraints.mdx +++ b/docs/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/python-dump-source-analysis.mdx b/docs/reference/goals/python-dump-source-analysis.mdx index 7ca46e697..ee1fc3552 100644 --- a/docs/reference/goals/python-dump-source-analysis.mdx +++ b/docs/reference/goals/python-dump-source-analysis.mdx @@ -1,5 +1,7 @@ --- title: python-dump-source-analysis +description: | + Dump source analysis for python_source targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/repl.mdx b/docs/reference/goals/repl.mdx index b2ecb84f1..4e438dda9 100644 --- a/docs/reference/goals/repl.mdx +++ b/docs/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/roots.mdx b/docs/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/docs/reference/goals/roots.mdx +++ b/docs/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/run.mdx b/docs/reference/goals/run.mdx index 4a26d2e66..0a3c0375e 100644 --- a/docs/reference/goals/run.mdx +++ b/docs/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/tailor.mdx b/docs/reference/goals/tailor.mdx index 816c96d67..6b400235c 100644 --- a/docs/reference/goals/tailor.mdx +++ b/docs/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/test.mdx b/docs/reference/goals/test.mdx index 2586d30f2..2e5d3f6b2 100644 --- a/docs/reference/goals/test.mdx +++ b/docs/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/update-build-files.mdx b/docs/reference/goals/update-build-files.mdx index 3bc7c40e9..9a165056d 100644 --- a/docs/reference/goals/update-build-files.mdx +++ b/docs/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/goals/version.mdx b/docs/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/docs/reference/goals/version.mdx +++ b/docs/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/add-trailing-comma.mdx b/docs/reference/subsystems/add-trailing-comma.mdx index 5b58e65c8..8b7dc4111 100644 --- a/docs/reference/subsystems/add-trailing-comma.mdx +++ b/docs/reference/subsystems/add-trailing-comma.mdx @@ -1,5 +1,7 @@ --- title: add-trailing-comma +description: | + The add-trailing-comma Python code formatter (https://github.com/asottile/add-trailing-comma). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/anonymous-telemetry.mdx b/docs/reference/subsystems/anonymous-telemetry.mdx index e3a4f1c5e..2e46089f8 100644 --- a/docs/reference/subsystems/anonymous-telemetry.mdx +++ b/docs/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/apache-thrift.mdx b/docs/reference/subsystems/apache-thrift.mdx index 8cd006a9a..ebd400bea 100644 --- a/docs/reference/subsystems/apache-thrift.mdx +++ b/docs/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/autoflake.mdx b/docs/reference/subsystems/autoflake.mdx index c9a7d0e71..9a9f946bf 100644 --- a/docs/reference/subsystems/autoflake.mdx +++ b/docs/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/bandit.mdx b/docs/reference/subsystems/bandit.mdx index 7d1468c16..183a7eae7 100644 --- a/docs/reference/subsystems/bandit.mdx +++ b/docs/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/black.mdx b/docs/reference/subsystems/black.mdx index 6fda653c3..018c92444 100644 --- a/docs/reference/subsystems/black.mdx +++ b/docs/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/buf.mdx b/docs/reference/subsystems/buf.mdx index bb8b39d59..06f4febda 100644 --- a/docs/reference/subsystems/buf.mdx +++ b/docs/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/build-deprecations-fixer.mdx b/docs/reference/subsystems/build-deprecations-fixer.mdx index 0f9b51fe4..0f9f27cf9 100644 --- a/docs/reference/subsystems/build-deprecations-fixer.mdx +++ b/docs/reference/subsystems/build-deprecations-fixer.mdx @@ -1,5 +1,7 @@ --- title: build-deprecations-fixer +description: | + A tool/plugin for fixing BUILD file deprecations (where possible). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/buildifier.mdx b/docs/reference/subsystems/buildifier.mdx index 3edd777d9..bed6a9c2a 100644 --- a/docs/reference/subsystems/buildifier.mdx +++ b/docs/reference/subsystems/buildifier.mdx @@ -1,5 +1,7 @@ --- title: buildifier +description: | + Buildifier is a tool for formatting BUILD files with a standard convention. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/changed.mdx b/docs/reference/subsystems/changed.mdx index 0b73d3b68..81d8d6720 100644 --- a/docs/reference/subsystems/changed.mdx +++ b/docs/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/cli.mdx b/docs/reference/subsystems/cli.mdx index 7a12ca8ca..c1d3d782d 100644 --- a/docs/reference/subsystems/cli.mdx +++ b/docs/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/coursier.mdx b/docs/reference/subsystems/coursier.mdx index cbd233d12..c0ffd849e 100644 --- a/docs/reference/subsystems/coursier.mdx +++ b/docs/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. (https://get-coursier.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/coverage-py.mdx b/docs/reference/subsystems/coverage-py.mdx index 23b49b2a8..be30ad96d 100644 --- a/docs/reference/subsystems/coverage-py.mdx +++ b/docs/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/debug-adapter.mdx b/docs/reference/subsystems/debug-adapter.mdx index d15f05658..655c51060 100644 --- a/docs/reference/subsystems/debug-adapter.mdx +++ b/docs/reference/subsystems/debug-adapter.mdx @@ -1,5 +1,7 @@ --- title: debug-adapter +description: | + Options used to configure and launch a Debug Adapter server. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/debugpy.mdx b/docs/reference/subsystems/debugpy.mdx index e05600cb2..272e5675f 100644 --- a/docs/reference/subsystems/debugpy.mdx +++ b/docs/reference/subsystems/debugpy.mdx @@ -1,5 +1,7 @@ --- title: debugpy +description: | + An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/docformatter.mdx b/docs/reference/subsystems/docformatter.mdx index a7fcf8c8c..b6d21ed56 100644 --- a/docs/reference/subsystems/docformatter.mdx +++ b/docs/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/docker.mdx b/docs/reference/subsystems/docker.mdx index 4b6591a46..008a63b72 100644 --- a/docs/reference/subsystems/docker.mdx +++ b/docs/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/dockerfile-parser.mdx b/docs/reference/subsystems/dockerfile-parser.mdx index 0e863f82c..b886e3216 100644 --- a/docs/reference/subsystems/dockerfile-parser.mdx +++ b/docs/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/download-terraform.mdx b/docs/reference/subsystems/download-terraform.mdx index b6c4ed3da..a6ec86e78 100644 --- a/docs/reference/subsystems/download-terraform.mdx +++ b/docs/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/environments-preview.mdx b/docs/reference/subsystems/environments-preview.mdx index 780bc8363..8231798c1 100644 --- a/docs/reference/subsystems/environments-preview.mdx +++ b/docs/reference/subsystems/environments-preview.mdx @@ -1,5 +1,7 @@ --- title: environments-preview +description: | + A highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/filter.mdx b/docs/reference/subsystems/filter.mdx index 2a6c4cef6..490732a64 100644 --- a/docs/reference/subsystems/filter.mdx +++ b/docs/reference/subsystems/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/flake8.mdx b/docs/reference/subsystems/flake8.mdx index 311d2c0a3..d98aef1e9 100644 --- a/docs/reference/subsystems/flake8.mdx +++ b/docs/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/go-test.mdx b/docs/reference/subsystems/go-test.mdx index 9f356582a..1e6939a1c 100644 --- a/docs/reference/subsystems/go-test.mdx +++ b/docs/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/gofmt.mdx b/docs/reference/subsystems/gofmt.mdx index 83a3eb9a5..e54bcdc75 100644 --- a/docs/reference/subsystems/gofmt.mdx +++ b/docs/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/golang.mdx b/docs/reference/subsystems/golang.mdx index 743947589..b9fd30c5f 100644 --- a/docs/reference/subsystems/golang.mdx +++ b/docs/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/google-java-format.mdx b/docs/reference/subsystems/google-java-format.mdx index 63135f390..0340acc7e 100644 --- a/docs/reference/subsystems/google-java-format.mdx +++ b/docs/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/grpc-python-plugin.mdx b/docs/reference/subsystems/grpc-python-plugin.mdx index af1a45f33..25601b5ac 100644 --- a/docs/reference/subsystems/grpc-python-plugin.mdx +++ b/docs/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/hadolint.mdx b/docs/reference/subsystems/hadolint.mdx index 76434fdb1..cfb8ce845 100644 --- a/docs/reference/subsystems/hadolint.mdx +++ b/docs/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/helm-k8s-parser.mdx b/docs/reference/subsystems/helm-k8s-parser.mdx index 41dad80c2..24e875743 100644 --- a/docs/reference/subsystems/helm-k8s-parser.mdx +++ b/docs/reference/subsystems/helm-k8s-parser.mdx @@ -1,5 +1,7 @@ --- title: helm-k8s-parser +description: | + Analyses K8S manifests rendered by Helm. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/helm-post-renderer.mdx b/docs/reference/subsystems/helm-post-renderer.mdx index 2387a0cdd..f4c906eeb 100644 --- a/docs/reference/subsystems/helm-post-renderer.mdx +++ b/docs/reference/subsystems/helm-post-renderer.mdx @@ -1,5 +1,7 @@ --- title: helm-post-renderer +description: | + Used perform modifications to the final output produced by Helm charts when they've been fully rendered. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/helm-unittest.mdx b/docs/reference/subsystems/helm-unittest.mdx index 80e49914b..4f2b872ab 100644 --- a/docs/reference/subsystems/helm-unittest.mdx +++ b/docs/reference/subsystems/helm-unittest.mdx @@ -1,5 +1,7 @@ --- title: helm-unittest +description: | + BDD styled unit test framework for Kubernetes Helm charts as a Helm plugin. (https://github.com/helm-unittest) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/helm.mdx b/docs/reference/subsystems/helm.mdx index 6ac0aaf43..42dce9c5b 100644 --- a/docs/reference/subsystems/helm.mdx +++ b/docs/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/ipython.mdx b/docs/reference/subsystems/ipython.mdx index 739b6650c..21fd0b08b 100644 --- a/docs/reference/subsystems/ipython.mdx +++ b/docs/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/isort.mdx b/docs/reference/subsystems/isort.mdx index 025bb36cb..130b229ab 100644 --- a/docs/reference/subsystems/isort.mdx +++ b/docs/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/jarjar.mdx b/docs/reference/subsystems/jarjar.mdx index f8ad18482..a55a23adf 100644 --- a/docs/reference/subsystems/jarjar.mdx +++ b/docs/reference/subsystems/jarjar.mdx @@ -1,5 +1,7 @@ --- title: jarjar +description: | + The Jar Jar Abrams tool (https://github.com/eed3si9n/jarjar-abrams) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/java-infer.mdx b/docs/reference/subsystems/java-infer.mdx index 9b365727f..2088e9ff2 100644 --- a/docs/reference/subsystems/java-infer.mdx +++ b/docs/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/javac.mdx b/docs/reference/subsystems/javac.mdx index 32f80db89..a7ac13086 100644 --- a/docs/reference/subsystems/javac.mdx +++ b/docs/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/junit.mdx b/docs/reference/subsystems/junit.mdx index e07076926..5388744dd 100644 --- a/docs/reference/subsystems/junit.mdx +++ b/docs/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/jvm.mdx b/docs/reference/subsystems/jvm.mdx index 20f80de22..4cee79248 100644 --- a/docs/reference/subsystems/jvm.mdx +++ b/docs/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/kotlin-infer.mdx b/docs/reference/subsystems/kotlin-infer.mdx index 1241c712c..89eb838c9 100644 --- a/docs/reference/subsystems/kotlin-infer.mdx +++ b/docs/reference/subsystems/kotlin-infer.mdx @@ -1,5 +1,7 @@ --- title: kotlin-infer +description: | + Options controlling which dependencies will be inferred for Kotlin targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/kotlin.mdx b/docs/reference/subsystems/kotlin.mdx index 25b150315..50785c245 100644 --- a/docs/reference/subsystems/kotlin.mdx +++ b/docs/reference/subsystems/kotlin.mdx @@ -1,5 +1,7 @@ --- title: kotlin +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/kotlinc.mdx b/docs/reference/subsystems/kotlinc.mdx index 428423319..3c9d68d40 100644 --- a/docs/reference/subsystems/kotlinc.mdx +++ b/docs/reference/subsystems/kotlinc.mdx @@ -1,5 +1,7 @@ --- title: kotlinc +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/ktlint.mdx b/docs/reference/subsystems/ktlint.mdx index 72fff7415..a9a23f999 100644 --- a/docs/reference/subsystems/ktlint.mdx +++ b/docs/reference/subsystems/ktlint.mdx @@ -1,5 +1,7 @@ --- title: ktlint +description: | + Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/mypy-protobuf.mdx b/docs/reference/subsystems/mypy-protobuf.mdx index d7153d100..5d3cc4483 100644 --- a/docs/reference/subsystems/mypy-protobuf.mdx +++ b/docs/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/mypy.mdx b/docs/reference/subsystems/mypy.mdx index 9d66920ba..cff5938a7 100644 --- a/docs/reference/subsystems/mypy.mdx +++ b/docs/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/nodejs-infer.mdx b/docs/reference/subsystems/nodejs-infer.mdx index ce0f1a9c9..2c3454f99 100644 --- a/docs/reference/subsystems/nodejs-infer.mdx +++ b/docs/reference/subsystems/nodejs-infer.mdx @@ -1,5 +1,7 @@ --- title: nodejs-infer +description: | + Options controlling which dependencies will be inferred for javascript targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/nodejs.mdx b/docs/reference/subsystems/nodejs.mdx index 3f2e8897d..70d53307a 100644 --- a/docs/reference/subsystems/nodejs.mdx +++ b/docs/reference/subsystems/nodejs.mdx @@ -1,5 +1,7 @@ --- title: nodejs +description: | + The Node.js Javascript runtime (including Corepack). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/openapi-format.mdx b/docs/reference/subsystems/openapi-format.mdx index 9e982c54e..d50430d7c 100644 --- a/docs/reference/subsystems/openapi-format.mdx +++ b/docs/reference/subsystems/openapi-format.mdx @@ -1,5 +1,7 @@ --- title: openapi-format +description: | + Format an OpenAPI document by ordering, formatting and filtering fields (https://github.com/thim81/openapi-format). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/openapi.mdx b/docs/reference/subsystems/openapi.mdx index e1bf02a46..78c72dfbc 100644 --- a/docs/reference/subsystems/openapi.mdx +++ b/docs/reference/subsystems/openapi.mdx @@ -1,5 +1,7 @@ --- title: openapi +description: | + The OpenAPI Specification (https://swagger.io/specification/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/pex-binary-defaults.mdx b/docs/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/docs/reference/subsystems/pex-binary-defaults.mdx +++ b/docs/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/pex-cli.mdx b/docs/reference/subsystems/pex-cli.mdx index c7818f29f..e46ee2988 100644 --- a/docs/reference/subsystems/pex-cli.mdx +++ b/docs/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/pex.mdx b/docs/reference/subsystems/pex.mdx index 6562ee0d6..368a1dc0d 100644 --- a/docs/reference/subsystems/pex.mdx +++ b/docs/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/preamble.mdx b/docs/reference/subsystems/preamble.mdx index 114f378e0..dcb1e80f0 100644 --- a/docs/reference/subsystems/preamble.mdx +++ b/docs/reference/subsystems/preamble.mdx @@ -1,5 +1,7 @@ --- title: preamble +description: | + Formats files with a preamble, with the preamble looked up based on path. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/protobuf-java-grpc.mdx b/docs/reference/subsystems/protobuf-java-grpc.mdx index 8bc65a5b9..ac5095717 100644 --- a/docs/reference/subsystems/protobuf-java-grpc.mdx +++ b/docs/reference/subsystems/protobuf-java-grpc.mdx @@ -1,5 +1,7 @@ --- title: protobuf-java-grpc +description: | + gRPC support for Java Protobuf (https://github.com/grpc/grpc-java) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/protoc.mdx b/docs/reference/subsystems/protoc.mdx index 8f4a694ac..a0320065f 100644 --- a/docs/reference/subsystems/protoc.mdx +++ b/docs/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/pydocstyle.mdx b/docs/reference/subsystems/pydocstyle.mdx index c0c865260..822f267a5 100644 --- a/docs/reference/subsystems/pydocstyle.mdx +++ b/docs/reference/subsystems/pydocstyle.mdx @@ -1,5 +1,7 @@ --- title: pydocstyle +description: | + A tool for checking compliance with Python docstring conventions (http://www.pydocstyle.org/en/stable/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/pylint.mdx b/docs/reference/subsystems/pylint.mdx index e3a3db13d..0a0cf5071 100644 --- a/docs/reference/subsystems/pylint.mdx +++ b/docs/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/pyoxidizer.mdx b/docs/reference/subsystems/pyoxidizer.mdx index 18cc98c52..ae19a72ab 100644 --- a/docs/reference/subsystems/pyoxidizer.mdx +++ b/docs/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/pytest.mdx b/docs/reference/subsystems/pytest.mdx index 212fb005d..6a3b73dfb 100644 --- a/docs/reference/subsystems/pytest.mdx +++ b/docs/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/python-bootstrap.mdx b/docs/reference/subsystems/python-bootstrap.mdx index 045e049fa..c8b39b6a7 100644 --- a/docs/reference/subsystems/python-bootstrap.mdx +++ b/docs/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/python-infer.mdx b/docs/reference/subsystems/python-infer.mdx index ab4e8adea..b8c07ad43 100644 --- a/docs/reference/subsystems/python-infer.mdx +++ b/docs/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/python-native-code.mdx b/docs/reference/subsystems/python-native-code.mdx index 766ddeedb..dfdb91103 100644 --- a/docs/reference/subsystems/python-native-code.mdx +++ b/docs/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/python-protobuf.mdx b/docs/reference/subsystems/python-protobuf.mdx index e787f2cd1..13a37b063 100644 --- a/docs/reference/subsystems/python-protobuf.mdx +++ b/docs/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/python-repos.mdx b/docs/reference/subsystems/python-repos.mdx index 1dd9d65d9..de1bf2369 100644 --- a/docs/reference/subsystems/python-repos.mdx +++ b/docs/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/python-thrift.mdx b/docs/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/docs/reference/subsystems/python-thrift.mdx +++ b/docs/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/python.mdx b/docs/reference/subsystems/python.mdx index 8443443b2..9e58e1657 100644 --- a/docs/reference/subsystems/python.mdx +++ b/docs/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/pytype.mdx b/docs/reference/subsystems/pytype.mdx index 066cbde0c..c71eead16 100644 --- a/docs/reference/subsystems/pytype.mdx +++ b/docs/reference/subsystems/pytype.mdx @@ -1,5 +1,7 @@ --- title: pytype +description: | + The Pytype utility for typechecking Python code (https://github.com/google/pytype). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/pyupgrade.mdx b/docs/reference/subsystems/pyupgrade.mdx index abb41a2d2..f83147281 100644 --- a/docs/reference/subsystems/pyupgrade.mdx +++ b/docs/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/regex-lint.mdx b/docs/reference/subsystems/regex-lint.mdx index 34376a064..0ae838c11 100644 --- a/docs/reference/subsystems/regex-lint.mdx +++ b/docs/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/ruff.mdx b/docs/reference/subsystems/ruff.mdx index 752b036ed..c1c304c6a 100644 --- a/docs/reference/subsystems/ruff.mdx +++ b/docs/reference/subsystems/ruff.mdx @@ -1,5 +1,7 @@ --- title: ruff +description: | + The Ruff Python formatter (https://github.com/astral-sh/ruff). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/scala-infer.mdx b/docs/reference/subsystems/scala-infer.mdx index 0f5579805..f3bca9b6b 100644 --- a/docs/reference/subsystems/scala-infer.mdx +++ b/docs/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/scala.mdx b/docs/reference/subsystems/scala.mdx index b55c6b2ae..8184f5acf 100644 --- a/docs/reference/subsystems/scala.mdx +++ b/docs/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/scalac.mdx b/docs/reference/subsystems/scalac.mdx index 93dd5914c..d2ddec7ca 100644 --- a/docs/reference/subsystems/scalac.mdx +++ b/docs/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/scalafmt.mdx b/docs/reference/subsystems/scalafmt.mdx index f8f0b0e70..50f198714 100644 --- a/docs/reference/subsystems/scalafmt.mdx +++ b/docs/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/scalapb.mdx b/docs/reference/subsystems/scalapb.mdx index ba3b390ca..b22b5e341 100644 --- a/docs/reference/subsystems/scalapb.mdx +++ b/docs/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/scalatest.mdx b/docs/reference/subsystems/scalatest.mdx index ac72d118e..b5daa46f3 100644 --- a/docs/reference/subsystems/scalatest.mdx +++ b/docs/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/scc.mdx b/docs/reference/subsystems/scc.mdx index f705a390a..837c206fe 100644 --- a/docs/reference/subsystems/scc.mdx +++ b/docs/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/semgrep.mdx b/docs/reference/subsystems/semgrep.mdx index cfb1e9233..cda280520 100644 --- a/docs/reference/subsystems/semgrep.mdx +++ b/docs/reference/subsystems/semgrep.mdx @@ -1,5 +1,7 @@ --- title: semgrep +description: | + Lightweight static analysis for many languages. Find bug variants with patterns that look like source code. (https://semgrep.dev/) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/setup-py-generation.mdx b/docs/reference/subsystems/setup-py-generation.mdx index 45795af4c..753cf558b 100644 --- a/docs/reference/subsystems/setup-py-generation.mdx +++ b/docs/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/setuptools-scm.mdx b/docs/reference/subsystems/setuptools-scm.mdx index 7183b51aa..03ab280d8 100644 --- a/docs/reference/subsystems/setuptools-scm.mdx +++ b/docs/reference/subsystems/setuptools-scm.mdx @@ -1,5 +1,7 @@ --- title: setuptools-scm +description: | + A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/setuptools.mdx b/docs/reference/subsystems/setuptools.mdx index 28e3ac008..d21f29b0f 100644 --- a/docs/reference/subsystems/setuptools.mdx +++ b/docs/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/shell-setup.mdx b/docs/reference/subsystems/shell-setup.mdx index 26bb6f1c9..6affb0d9b 100644 --- a/docs/reference/subsystems/shell-setup.mdx +++ b/docs/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/shell-test.mdx b/docs/reference/subsystems/shell-test.mdx index 489c11311..311238694 100644 --- a/docs/reference/subsystems/shell-test.mdx +++ b/docs/reference/subsystems/shell-test.mdx @@ -1,5 +1,7 @@ --- title: shell-test +description: | + Options for Pants' Shell test support. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/shellcheck.mdx b/docs/reference/subsystems/shellcheck.mdx index a138ad7d3..eadff0c7c 100644 --- a/docs/reference/subsystems/shellcheck.mdx +++ b/docs/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/shfmt.mdx b/docs/reference/subsystems/shfmt.mdx index 258072902..f6f1fa47d 100644 --- a/docs/reference/subsystems/shfmt.mdx +++ b/docs/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/shunit2.mdx b/docs/reference/subsystems/shunit2.mdx index 978d1ab09..41e577eea 100644 --- a/docs/reference/subsystems/shunit2.mdx +++ b/docs/reference/subsystems/shunit2.mdx @@ -1,5 +1,7 @@ --- title: shunit2 +description: | + shUnit2 is a xUnit framework for Bourne based shell scripts (https://github.com/kward/shunit2) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/source.mdx b/docs/reference/subsystems/source.mdx index 65c7abba6..3d42e6fca 100644 --- a/docs/reference/subsystems/source.mdx +++ b/docs/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/spectral.mdx b/docs/reference/subsystems/spectral.mdx index 685a7e52e..011e995fb 100644 --- a/docs/reference/subsystems/spectral.mdx +++ b/docs/reference/subsystems/spectral.mdx @@ -1,5 +1,7 @@ --- title: spectral +description: | + A flexible JSON/YAML linter for creating automated style guides (https://github.com/stoplightio/spectral). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/stats.mdx b/docs/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/docs/reference/subsystems/stats.mdx +++ b/docs/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/subprocess-environment.mdx b/docs/reference/subsystems/subprocess-environment.mdx index 68ae35794..37fd3a0db 100644 --- a/docs/reference/subsystems/subprocess-environment.mdx +++ b/docs/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/system-binaries.mdx b/docs/reference/subsystems/system-binaries.mdx index ac867da36..acb59acf9 100644 --- a/docs/reference/subsystems/system-binaries.mdx +++ b/docs/reference/subsystems/system-binaries.mdx @@ -1,5 +1,7 @@ --- title: system-binaries +description: | + System binaries related settings. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/terraform-fmt.mdx b/docs/reference/subsystems/terraform-fmt.mdx index 49bbf119b..e967d1f9c 100644 --- a/docs/reference/subsystems/terraform-fmt.mdx +++ b/docs/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/terraform-hcl2-parser.mdx b/docs/reference/subsystems/terraform-hcl2-parser.mdx index 1ecba7b26..d7bec7e29 100644 --- a/docs/reference/subsystems/terraform-hcl2-parser.mdx +++ b/docs/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/terraform-validate.mdx b/docs/reference/subsystems/terraform-validate.mdx index edb178a87..6cb16de11 100644 --- a/docs/reference/subsystems/terraform-validate.mdx +++ b/docs/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/thrift.mdx b/docs/reference/subsystems/thrift.mdx index 230854701..7a691f82d 100644 --- a/docs/reference/subsystems/thrift.mdx +++ b/docs/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/twine.mdx b/docs/reference/subsystems/twine.mdx index 68d4d1dbd..de7ba9b85 100644 --- a/docs/reference/subsystems/twine.mdx +++ b/docs/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPI and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/workunit-logger.mdx b/docs/reference/subsystems/workunit-logger.mdx index a33434a0e..09183ea36 100644 --- a/docs/reference/subsystems/workunit-logger.mdx +++ b/docs/reference/subsystems/workunit-logger.mdx @@ -1,5 +1,7 @@ --- title: workunit-logger +description: | + Workunit Logger subsystem. Useful for debugging pants itself. --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/yamllint.mdx b/docs/reference/subsystems/yamllint.mdx index eaa13589a..acd871d9f 100644 --- a/docs/reference/subsystems/yamllint.mdx +++ b/docs/reference/subsystems/yamllint.mdx @@ -1,5 +1,7 @@ --- title: yamllint +description: | + A linter for YAML files (https://yamllint.readthedocs.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/subsystems/yapf.mdx b/docs/reference/subsystems/yapf.mdx index 4156e8d57..508ce75cb 100644 --- a/docs/reference/subsystems/yapf.mdx +++ b/docs/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/docs/reference/targets/adhoc_tool.mdx b/docs/reference/targets/adhoc_tool.mdx index 985e36caa..8b2d1dd9a 100644 --- a/docs/reference/targets/adhoc_tool.mdx +++ b/docs/reference/targets/adhoc_tool.mdx @@ -1,5 +1,7 @@ --- title: adhoc_tool +description: | + Execute any runnable target for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/archive.mdx b/docs/reference/targets/archive.mdx index b3f69629d..114cb1b42 100644 --- a/docs/reference/targets/archive.mdx +++ b/docs/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/code_quality_tool.mdx b/docs/reference/targets/code_quality_tool.mdx index b9117e2d3..955813f83 100644 --- a/docs/reference/targets/code_quality_tool.mdx +++ b/docs/reference/targets/code_quality_tool.mdx @@ -1,5 +1,7 @@ --- title: code_quality_tool +description: | + Configure a runnable to use as a linter, fixer or formatter --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/deploy_jar.mdx b/docs/reference/targets/deploy_jar.mdx index 54b6c8aca..f5bcf119e 100644 --- a/docs/reference/targets/deploy_jar.mdx +++ b/docs/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/docker_environment.mdx b/docs/reference/targets/docker_environment.mdx index 2b4b8d004..d044e1b85 100644 --- a/docs/reference/targets/docker_environment.mdx +++ b/docs/reference/targets/docker_environment.mdx @@ -1,5 +1,7 @@ --- title: docker_environment +description: | + Configuration of a Docker environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/docker_image.mdx b/docs/reference/targets/docker_image.mdx index e29ebb08d..ca34ddc3e 100644 --- a/docs/reference/targets/docker_image.mdx +++ b/docs/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/experimental_test_shell_command.mdx b/docs/reference/targets/experimental_test_shell_command.mdx index 58eccc73a..7fbf84805 100644 --- a/docs/reference/targets/experimental_test_shell_command.mdx +++ b/docs/reference/targets/experimental_test_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_test_shell_command +description: | + Run a script as a test via the `test` goal, with all dependencies packaged/copied available in the chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/experimental_wrap_as_go_package_sources.mdx b/docs/reference/targets/experimental_wrap_as_go_package_sources.mdx index 0630639a4..b12d53c8d 100644 --- a/docs/reference/targets/experimental_wrap_as_go_package_sources.mdx +++ b/docs/reference/targets/experimental_wrap_as_go_package_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_go_package_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `GoPackageSourcesField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/experimental_wrap_as_java_sources.mdx b/docs/reference/targets/experimental_wrap_as_java_sources.mdx index ff3e04681..c3c6f8c4d 100644 --- a/docs/reference/targets/experimental_wrap_as_java_sources.mdx +++ b/docs/reference/targets/experimental_wrap_as_java_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_java_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `JavaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/experimental_wrap_as_kotlin_sources.mdx b/docs/reference/targets/experimental_wrap_as_kotlin_sources.mdx index bae3428a7..a17b55a26 100644 --- a/docs/reference/targets/experimental_wrap_as_kotlin_sources.mdx +++ b/docs/reference/targets/experimental_wrap_as_kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_kotlin_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `KotlinSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/experimental_wrap_as_python_sources.mdx b/docs/reference/targets/experimental_wrap_as_python_sources.mdx index 5751ec09f..169ffa6c2 100644 --- a/docs/reference/targets/experimental_wrap_as_python_sources.mdx +++ b/docs/reference/targets/experimental_wrap_as_python_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_python_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `PythonSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/experimental_wrap_as_resources.mdx b/docs/reference/targets/experimental_wrap_as_resources.mdx index 7f60252a5..01b2659c6 100644 --- a/docs/reference/targets/experimental_wrap_as_resources.mdx +++ b/docs/reference/targets/experimental_wrap_as_resources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_resources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ResourceSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/experimental_wrap_as_scala_sources.mdx b/docs/reference/targets/experimental_wrap_as_scala_sources.mdx index 5548c481b..d08d758a2 100644 --- a/docs/reference/targets/experimental_wrap_as_scala_sources.mdx +++ b/docs/reference/targets/experimental_wrap_as_scala_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_scala_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ScalaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/file.mdx b/docs/reference/targets/file.mdx index a05115348..c374f6c1f 100644 --- a/docs/reference/targets/file.mdx +++ b/docs/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/files.mdx b/docs/reference/targets/files.mdx index c146b1da0..eec81cba1 100644 --- a/docs/reference/targets/files.mdx +++ b/docs/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/go_binary.mdx b/docs/reference/targets/go_binary.mdx index e1a85a7a6..3762d6c9d 100644 --- a/docs/reference/targets/go_binary.mdx +++ b/docs/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/go_mod.mdx b/docs/reference/targets/go_mod.mdx index a0cfd6173..eddaa16fd 100644 --- a/docs/reference/targets/go_mod.mdx +++ b/docs/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/go_package.mdx b/docs/reference/targets/go_package.mdx index 7d5d93f4a..9a0f7beda 100644 --- a/docs/reference/targets/go_package.mdx +++ b/docs/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/go_third_party_package.mdx b/docs/reference/targets/go_third_party_package.mdx index 8de2a3727..18269909e 100644 --- a/docs/reference/targets/go_third_party_package.mdx +++ b/docs/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/helm_artifact.mdx b/docs/reference/targets/helm_artifact.mdx index df2c66974..3278b9c18 100644 --- a/docs/reference/targets/helm_artifact.mdx +++ b/docs/reference/targets/helm_artifact.mdx @@ -1,5 +1,7 @@ --- title: helm_artifact +description: | + A third party Helm artifact. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/helm_chart.mdx b/docs/reference/targets/helm_chart.mdx index 1e3fb87e6..62d10039a 100644 --- a/docs/reference/targets/helm_chart.mdx +++ b/docs/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/helm_deployment.mdx b/docs/reference/targets/helm_deployment.mdx index 09b923cdb..88f6aec14 100644 --- a/docs/reference/targets/helm_deployment.mdx +++ b/docs/reference/targets/helm_deployment.mdx @@ -1,5 +1,7 @@ --- title: helm_deployment +description: | + A Helm chart deployment. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/helm_unittest_test.mdx b/docs/reference/targets/helm_unittest_test.mdx index e43f1e44b..c8f05b155 100644 --- a/docs/reference/targets/helm_unittest_test.mdx +++ b/docs/reference/targets/helm_unittest_test.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_test +description: | + A single helm-unittest suite file. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/helm_unittest_tests.mdx b/docs/reference/targets/helm_unittest_tests.mdx index 4dd970035..8e707903b 100644 --- a/docs/reference/targets/helm_unittest_tests.mdx +++ b/docs/reference/targets/helm_unittest_tests.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_tests +description: | + Generates a `helm_unittest_test` target per each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/java_source.mdx b/docs/reference/targets/java_source.mdx index 9505ad6f7..d4818caaa 100644 --- a/docs/reference/targets/java_source.mdx +++ b/docs/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/java_sources.mdx b/docs/reference/targets/java_sources.mdx index ebab174f6..be98a18e1 100644 --- a/docs/reference/targets/java_sources.mdx +++ b/docs/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/junit_test.mdx b/docs/reference/targets/junit_test.mdx index 3dd02181b..1ba8abb79 100644 --- a/docs/reference/targets/junit_test.mdx +++ b/docs/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/junit_tests.mdx b/docs/reference/targets/junit_tests.mdx index dfca8fad4..aa1664dfe 100644 --- a/docs/reference/targets/junit_tests.mdx +++ b/docs/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/jvm_artifact.mdx b/docs/reference/targets/jvm_artifact.mdx index eac38295f..d1bd1fe5d 100644 --- a/docs/reference/targets/jvm_artifact.mdx +++ b/docs/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/jvm_war.mdx b/docs/reference/targets/jvm_war.mdx index 393b9ec79..6a451da00 100644 --- a/docs/reference/targets/jvm_war.mdx +++ b/docs/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/kotlin_junit_test.mdx b/docs/reference/targets/kotlin_junit_test.mdx index efeef9922..3ba33c63b 100644 --- a/docs/reference/targets/kotlin_junit_test.mdx +++ b/docs/reference/targets/kotlin_junit_test.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_test +description: | + A single Kotlin test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/kotlin_junit_tests.mdx b/docs/reference/targets/kotlin_junit_tests.mdx index 6d842668f..4002566ca 100644 --- a/docs/reference/targets/kotlin_junit_tests.mdx +++ b/docs/reference/targets/kotlin_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_tests +description: | + Generate a `kotlin_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/kotlin_source.mdx b/docs/reference/targets/kotlin_source.mdx index 9db4549a7..e090f456f 100644 --- a/docs/reference/targets/kotlin_source.mdx +++ b/docs/reference/targets/kotlin_source.mdx @@ -1,5 +1,7 @@ --- title: kotlin_source +description: | + A single Kotlin source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/kotlin_sources.mdx b/docs/reference/targets/kotlin_sources.mdx index c3a909512..aea220d1a 100644 --- a/docs/reference/targets/kotlin_sources.mdx +++ b/docs/reference/targets/kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: kotlin_sources +description: | + Generate a `kotlin_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/kotlinc_plugin.mdx b/docs/reference/targets/kotlinc_plugin.mdx index 828754fa0..2614957de 100644 --- a/docs/reference/targets/kotlinc_plugin.mdx +++ b/docs/reference/targets/kotlinc_plugin.mdx @@ -1,5 +1,7 @@ --- title: kotlinc_plugin +description: | + A plugin for `kotlinc`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/local_environment.mdx b/docs/reference/targets/local_environment.mdx index a71909d0d..900efa8a6 100644 --- a/docs/reference/targets/local_environment.mdx +++ b/docs/reference/targets/local_environment.mdx @@ -1,5 +1,7 @@ --- title: local_environment +description: | + Configuration of a local execution environment for specific platforms. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/openapi_document.mdx b/docs/reference/targets/openapi_document.mdx index 0d7877c89..97214cdab 100644 --- a/docs/reference/targets/openapi_document.mdx +++ b/docs/reference/targets/openapi_document.mdx @@ -1,5 +1,7 @@ --- title: openapi_document +description: | + A single OpenAPI document file. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/openapi_documents.mdx b/docs/reference/targets/openapi_documents.mdx index 2eedb6401..781904e85 100644 --- a/docs/reference/targets/openapi_documents.mdx +++ b/docs/reference/targets/openapi_documents.mdx @@ -1,5 +1,7 @@ --- title: openapi_documents +description: | + Generate an `openapi_document` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/openapi_source.mdx b/docs/reference/targets/openapi_source.mdx index 1f766dce0..a0677dd88 100644 --- a/docs/reference/targets/openapi_source.mdx +++ b/docs/reference/targets/openapi_source.mdx @@ -1,5 +1,7 @@ --- title: openapi_source +description: | + A single OpenAPI source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/openapi_sources.mdx b/docs/reference/targets/openapi_sources.mdx index d658b28c0..556fc3a05 100644 --- a/docs/reference/targets/openapi_sources.mdx +++ b/docs/reference/targets/openapi_sources.mdx @@ -1,5 +1,7 @@ --- title: openapi_sources +description: | + Generate an `openapi_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/pants_requirements.mdx b/docs/reference/targets/pants_requirements.mdx index 83993d48e..fc917528e 100644 --- a/docs/reference/targets/pants_requirements.mdx +++ b/docs/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/pex_binaries.mdx b/docs/reference/targets/pex_binaries.mdx index e41f53e36..b56e1bfc1 100644 --- a/docs/reference/targets/pex_binaries.mdx +++ b/docs/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/pex_binary.mdx b/docs/reference/targets/pex_binary.mdx index 90df8b650..53906df89 100644 --- a/docs/reference/targets/pex_binary.mdx +++ b/docs/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/pipenv_requirements.mdx b/docs/reference/targets/pipenv_requirements.mdx index f67f613c7..8232eece0 100644 --- a/docs/reference/targets/pipenv_requirements.mdx +++ b/docs/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/poetry_requirements.mdx b/docs/reference/targets/poetry_requirements.mdx index 6edf88e02..b33cbf23b 100644 --- a/docs/reference/targets/poetry_requirements.mdx +++ b/docs/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry `pyproject.toml`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/protobuf_source.mdx b/docs/reference/targets/protobuf_source.mdx index 2c0fd036d..5a1261211 100644 --- a/docs/reference/targets/protobuf_source.mdx +++ b/docs/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/protobuf_sources.mdx b/docs/reference/targets/protobuf_sources.mdx index 6562db0ee..9fc31d399 100644 --- a/docs/reference/targets/protobuf_sources.mdx +++ b/docs/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/pyoxidizer_binary.mdx b/docs/reference/targets/pyoxidizer_binary.mdx index c4d81128b..14a64d725 100644 --- a/docs/reference/targets/pyoxidizer_binary.mdx +++ b/docs/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_aws_lambda_function.mdx b/docs/reference/targets/python_aws_lambda_function.mdx index d6585c5c1..be0e2389d 100644 --- a/docs/reference/targets/python_aws_lambda_function.mdx +++ b/docs/reference/targets/python_aws_lambda_function.mdx @@ -1,5 +1,7 @@ --- title: python_aws_lambda_function +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_aws_lambda_layer.mdx b/docs/reference/targets/python_aws_lambda_layer.mdx index 3d424fed7..19ec8b708 100644 --- a/docs/reference/targets/python_aws_lambda_layer.mdx +++ b/docs/reference/targets/python_aws_lambda_layer.mdx @@ -1,5 +1,7 @@ --- title: python_aws_lambda_layer +description: | + A Python layer suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_distribution.mdx b/docs/reference/targets/python_distribution.mdx index a9531a02c..080bfda8d 100644 --- a/docs/reference/targets/python_distribution.mdx +++ b/docs/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_google_cloud_function.mdx b/docs/reference/targets/python_google_cloud_function.mdx index 0b127347b..deef3442f 100644 --- a/docs/reference/targets/python_google_cloud_function.mdx +++ b/docs/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_requirement.mdx b/docs/reference/targets/python_requirement.mdx index 65b89a011..8d3207630 100644 --- a/docs/reference/targets/python_requirement.mdx +++ b/docs/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_requirements.mdx b/docs/reference/targets/python_requirements.mdx index b4078a301..a891310f2 100644 --- a/docs/reference/targets/python_requirements.mdx +++ b/docs/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style or PEP 621 compliant `pyproject.toml` file. The choice of parser for the `source` field is determined by the file name. If the `source` field ends with `pyproject.toml`, then the file is assumed to be a PEP 621 compliant file. Any other file name uses the requirements.txt-style parser. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_source.mdx b/docs/reference/targets/python_source.mdx index d9dde8c7a..d8712ac84 100644 --- a/docs/reference/targets/python_source.mdx +++ b/docs/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_sources.mdx b/docs/reference/targets/python_sources.mdx index e1f280449..393f3371f 100644 --- a/docs/reference/targets/python_sources.mdx +++ b/docs/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_test.mdx b/docs/reference/targets/python_test.mdx index 2f0a1bfd8..cb9d01a01 100644 --- a/docs/reference/targets/python_test.mdx +++ b/docs/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_test_utils.mdx b/docs/reference/targets/python_test_utils.mdx index b1b25cb70..d4c751f67 100644 --- a/docs/reference/targets/python_test_utils.mdx +++ b/docs/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/python_tests.mdx b/docs/reference/targets/python_tests.mdx index 58692a1d2..b446141b3 100644 --- a/docs/reference/targets/python_tests.mdx +++ b/docs/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/relocated_files.mdx b/docs/reference/targets/relocated_files.mdx index 346339e69..9efc94ea5 100644 --- a/docs/reference/targets/relocated_files.mdx +++ b/docs/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/remote_environment.mdx b/docs/reference/targets/remote_environment.mdx index 5bb6b9a01..25c92af40 100644 --- a/docs/reference/targets/remote_environment.mdx +++ b/docs/reference/targets/remote_environment.mdx @@ -1,5 +1,7 @@ --- title: remote_environment +description: | + Configuration of a remote execution environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/resource.mdx b/docs/reference/targets/resource.mdx index df41a0aee..9abda5ead 100644 --- a/docs/reference/targets/resource.mdx +++ b/docs/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/resources.mdx b/docs/reference/targets/resources.mdx index 0713753e0..65def90f1 100644 --- a/docs/reference/targets/resources.mdx +++ b/docs/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/run_shell_command.mdx b/docs/reference/targets/run_shell_command.mdx index bf8dfe79c..e705072a2 100644 --- a/docs/reference/targets/run_shell_command.mdx +++ b/docs/reference/targets/run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/scala_artifact.mdx b/docs/reference/targets/scala_artifact.mdx index 448da20e3..5b736c239 100644 --- a/docs/reference/targets/scala_artifact.mdx +++ b/docs/reference/targets/scala_artifact.mdx @@ -1,5 +1,7 @@ --- title: scala_artifact +description: | + A third-party Scala artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/scala_junit_test.mdx b/docs/reference/targets/scala_junit_test.mdx index f4b9e518c..fbac924c8 100644 --- a/docs/reference/targets/scala_junit_test.mdx +++ b/docs/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/scala_junit_tests.mdx b/docs/reference/targets/scala_junit_tests.mdx index 470e49385..5eb8a82f6 100644 --- a/docs/reference/targets/scala_junit_tests.mdx +++ b/docs/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/scala_source.mdx b/docs/reference/targets/scala_source.mdx index 302035e13..4abef6932 100644 --- a/docs/reference/targets/scala_source.mdx +++ b/docs/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/scala_sources.mdx b/docs/reference/targets/scala_sources.mdx index 11e330d11..e22e60f34 100644 --- a/docs/reference/targets/scala_sources.mdx +++ b/docs/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/scalac_plugin.mdx b/docs/reference/targets/scalac_plugin.mdx index 5debfdf3a..d6596589c 100644 --- a/docs/reference/targets/scalac_plugin.mdx +++ b/docs/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/scalatest_test.mdx b/docs/reference/targets/scalatest_test.mdx index c53d700d0..5e1e06bd1 100644 --- a/docs/reference/targets/scalatest_test.mdx +++ b/docs/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/scalatest_tests.mdx b/docs/reference/targets/scalatest_tests.mdx index 2bff84a27..635f4fb99 100644 --- a/docs/reference/targets/scalatest_tests.mdx +++ b/docs/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching `('*Spec.scala', '*Suite.scala')`). --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/shell_command.mdx b/docs/reference/targets/shell_command.mdx index 1e096b900..93850944e 100644 --- a/docs/reference/targets/shell_command.mdx +++ b/docs/reference/targets/shell_command.mdx @@ -1,5 +1,7 @@ --- title: shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/shell_source.mdx b/docs/reference/targets/shell_source.mdx index 1c6dc5bdc..abb704087 100644 --- a/docs/reference/targets/shell_source.mdx +++ b/docs/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/shell_sources.mdx b/docs/reference/targets/shell_sources.mdx index e84b6f488..cfce08da8 100644 --- a/docs/reference/targets/shell_sources.mdx +++ b/docs/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/shunit2_test.mdx b/docs/reference/targets/shunit2_test.mdx index 2f82fc266..ef0044cb1 100644 --- a/docs/reference/targets/shunit2_test.mdx +++ b/docs/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/shunit2_tests.mdx b/docs/reference/targets/shunit2_tests.mdx index 52a4ad9d9..ae8af9440 100644 --- a/docs/reference/targets/shunit2_tests.mdx +++ b/docs/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/system_binary.mdx b/docs/reference/targets/system_binary.mdx index d7bd775a0..017c61020 100644 --- a/docs/reference/targets/system_binary.mdx +++ b/docs/reference/targets/system_binary.mdx @@ -1,5 +1,7 @@ --- title: system_binary +description: | + A system binary that can be run with `pants run` or consumed by `adhoc_tool`. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/target.mdx b/docs/reference/targets/target.mdx index 18d9f91f0..8084fd92a 100644 --- a/docs/reference/targets/target.mdx +++ b/docs/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/terraform_deployment.mdx b/docs/reference/targets/terraform_deployment.mdx index fec9f55e0..d65696bce 100644 --- a/docs/reference/targets/terraform_deployment.mdx +++ b/docs/reference/targets/terraform_deployment.mdx @@ -1,5 +1,7 @@ --- title: terraform_deployment +description: | + A deployment of Terraform --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/terraform_module.mdx b/docs/reference/targets/terraform_module.mdx index fbede7796..41a75b0f9 100644 --- a/docs/reference/targets/terraform_module.mdx +++ b/docs/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/thrift_source.mdx b/docs/reference/targets/thrift_source.mdx index 59d3e6e61..7033305b1 100644 --- a/docs/reference/targets/thrift_source.mdx +++ b/docs/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/thrift_sources.mdx b/docs/reference/targets/thrift_sources.mdx index 1c9fd65a9..0aef860d1 100644 --- a/docs/reference/targets/thrift_sources.mdx +++ b/docs/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/docs/reference/targets/vcs_version.mdx b/docs/reference/targets/vcs_version.mdx index 03d0ae014..a5ee88347 100644 --- a/docs/reference/targets/vcs_version.mdx +++ b/docs/reference/targets/vcs_version.mdx @@ -1,5 +1,7 @@ --- title: vcs_version +description: | + Generates a version string from VCS state. --- import Field from "@site/src/components/reference/Field"; diff --git a/reference_codegen/generate.mjs b/reference_codegen/generate.mjs index 293ae5e67..0c8d3d35d 100644 --- a/reference_codegen/generate.mjs +++ b/reference_codegen/generate.mjs @@ -238,6 +238,8 @@ helpAll.scope_to_help_info[""].basic.forEach((option) => { }); Object.entries(helpAll.scope_to_help_info).forEach(([scope, info]) => { + info.description = convertDescription(info.description); + info.short_description = info.description.split("\n")[0]; ["basic", "advanced", "deprecated"].forEach((optionsType) => { info[optionsType].forEach((option) => { option.default = convertDefault(option.default, option.typ); @@ -266,13 +268,14 @@ await Promise.all([ // Global Options writeFile( "global-options.mdx", - renderSubsystemTemplate(helpAll["scope_to_help_info"][""], helpAll) + renderSubsystemTemplate( + helpAll["scope_to_help_info"][globalScopeInternal], + helpAll + ) ), // Subsystems ...Object.entries(helpAll.scope_to_help_info).map(async ([scope, info]) => { - if (scope === "") return; - - info.description = convertDescription(info.description); + if (scope === globalScopeInternal) return; const parent = info.is_goal ? "goals" : "subsystems"; await writeFile( path.join(parent, `${info.scope}.mdx`), @@ -286,6 +289,7 @@ await Promise.all([ if (info.alias.startsWith("_")) return; info.description = convertDescription(info.description); + info.short_description = info.description.split("\n")[0]; await writeFile( path.join("targets", `${info.alias}.mdx`), renderTargetTemplate(info) diff --git a/reference_codegen/subsystem.mdx.mustache b/reference_codegen/subsystem.mdx.mustache index 3cfd4d1f5..80a11b54d 100644 --- a/reference_codegen/subsystem.mdx.mustache +++ b/reference_codegen/subsystem.mdx.mustache @@ -1,5 +1,7 @@ --- title: {{#scope}}{{scope}}{{/scope}}{{^scope}}Global options{{/scope}} +description: | + {{{short_description}}} --- import Option from "@site/src/components/reference/Option"; diff --git a/reference_codegen/target.mdx.mustache b/reference_codegen/target.mdx.mustache index 982b1a7a4..bbd923fb3 100644 --- a/reference_codegen/target.mdx.mustache +++ b/reference_codegen/target.mdx.mustache @@ -1,5 +1,7 @@ --- title: {{ alias }} +description: | + {{{short_description}}} --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/global-options.mdx b/versioned_docs/version-2.0/reference/global-options.mdx index 99e5bf71f..39951e304 100644 --- a/versioned_docs/version-2.0/reference/global-options.mdx +++ b/versioned_docs/version-2.0/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/awslambda.mdx b/versioned_docs/version-2.0/reference/goals/awslambda.mdx index 764cb976b..78c652934 100644 --- a/versioned_docs/version-2.0/reference/goals/awslambda.mdx +++ b/versioned_docs/version-2.0/reference/goals/awslambda.mdx @@ -1,5 +1,7 @@ --- title: awslambda +description: | + Deprecated in favor of the `package` goal. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/binary.mdx b/versioned_docs/version-2.0/reference/goals/binary.mdx index 5d529f212..12bf4b40b 100644 --- a/versioned_docs/version-2.0/reference/goals/binary.mdx +++ b/versioned_docs/version-2.0/reference/goals/binary.mdx @@ -1,5 +1,7 @@ --- title: binary +description: | + Deprecated in favor of the `package` goal. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/count-loc.mdx b/versioned_docs/version-2.0/reference/goals/count-loc.mdx index a3b53e783..06ee32951 100644 --- a/versioned_docs/version-2.0/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.0/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/dependees.mdx b/versioned_docs/version-2.0/reference/goals/dependees.mdx index a0f25c578..d8e604698 100644 --- a/versioned_docs/version-2.0/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.0/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/dependencies.mdx b/versioned_docs/version-2.0/reference/goals/dependencies.mdx index df1a18e07..35ab9042e 100644 --- a/versioned_docs/version-2.0/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.0/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/filedeps.mdx b/versioned_docs/version-2.0/reference/goals/filedeps.mdx index 515489a18..bf3b5b2ae 100644 --- a/versioned_docs/version-2.0/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.0/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/filter.mdx b/versioned_docs/version-2.0/reference/goals/filter.mdx index ae789b2a7..7b353921f 100644 --- a/versioned_docs/version-2.0/reference/goals/filter.mdx +++ b/versioned_docs/version-2.0/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/fmt.mdx b/versioned_docs/version-2.0/reference/goals/fmt.mdx index c9a5c7145..a56d22196 100644 --- a/versioned_docs/version-2.0/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.0/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/lint.mdx b/versioned_docs/version-2.0/reference/goals/lint.mdx index c5a61601c..81f427969 100644 --- a/versioned_docs/version-2.0/reference/goals/lint.mdx +++ b/versioned_docs/version-2.0/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/list.mdx b/versioned_docs/version-2.0/reference/goals/list.mdx index 4113eddb3..10b1f36b9 100644 --- a/versioned_docs/version-2.0/reference/goals/list.mdx +++ b/versioned_docs/version-2.0/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/package.mdx b/versioned_docs/version-2.0/reference/goals/package.mdx index 5b6bb28a4..cf288c6b3 100644 --- a/versioned_docs/version-2.0/reference/goals/package.mdx +++ b/versioned_docs/version-2.0/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/repl.mdx b/versioned_docs/version-2.0/reference/goals/repl.mdx index 2b514c49c..b653d8553 100644 --- a/versioned_docs/version-2.0/reference/goals/repl.mdx +++ b/versioned_docs/version-2.0/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/roots.mdx b/versioned_docs/version-2.0/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.0/reference/goals/roots.mdx +++ b/versioned_docs/version-2.0/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/run.mdx b/versioned_docs/version-2.0/reference/goals/run.mdx index 69b22b42a..07d26ed32 100644 --- a/versioned_docs/version-2.0/reference/goals/run.mdx +++ b/versioned_docs/version-2.0/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/setup-py.mdx b/versioned_docs/version-2.0/reference/goals/setup-py.mdx index 865f9f238..950c1c178 100644 --- a/versioned_docs/version-2.0/reference/goals/setup-py.mdx +++ b/versioned_docs/version-2.0/reference/goals/setup-py.mdx @@ -1,5 +1,7 @@ --- title: setup-py +description: | + Deprecated in favor of the `package` goal. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/test.mdx b/versioned_docs/version-2.0/reference/goals/test.mdx index 0ce95ea0d..725dd6af5 100644 --- a/versioned_docs/version-2.0/reference/goals/test.mdx +++ b/versioned_docs/version-2.0/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/typecheck.mdx b/versioned_docs/version-2.0/reference/goals/typecheck.mdx index 660de7077..6dad17a1c 100644 --- a/versioned_docs/version-2.0/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.0/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checkers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/goals/validate.mdx b/versioned_docs/version-2.0/reference/goals/validate.mdx index 8970dbe36..42e37f2d5 100644 --- a/versioned_docs/version-2.0/reference/goals/validate.mdx +++ b/versioned_docs/version-2.0/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/bandit.mdx b/versioned_docs/version-2.0/reference/subsystems/bandit.mdx index cca77241d..e1e66617a 100644 --- a/versioned_docs/version-2.0/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/basicauth.mdx b/versioned_docs/version-2.0/reference/subsystems/basicauth.mdx index 9d84e7a6d..461a9e5a6 100644 --- a/versioned_docs/version-2.0/reference/subsystems/basicauth.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/basicauth.mdx @@ -1,5 +1,7 @@ --- title: basicauth +description: | + Support for HTTP basicauth. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/black.mdx b/versioned_docs/version-2.0/reference/subsystems/black.mdx index 420ffe609..570cfae50 100644 --- a/versioned_docs/version-2.0/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/changed.mdx b/versioned_docs/version-2.0/reference/subsystems/changed.mdx index 737ae9c66..3cbfda7fa 100644 --- a/versioned_docs/version-2.0/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/cookies.mdx b/versioned_docs/version-2.0/reference/subsystems/cookies.mdx index a96058ee4..9c44ca9da 100644 --- a/versioned_docs/version-2.0/reference/subsystems/cookies.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/cookies.mdx @@ -1,5 +1,7 @@ --- title: cookies +description: | + Manages HTTP cookies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.0/reference/subsystems/coverage-py.mdx index e29b8601e..d06ab4aae 100644 --- a/versioned_docs/version-2.0/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.0/reference/subsystems/docformatter.mdx index 9cf767cd3..e5f64d5ae 100644 --- a/versioned_docs/version-2.0/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.0/reference/subsystems/download-pex-bin.mdx index 98a63005a..30086b470 100644 --- a/versioned_docs/version-2.0/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/flake8.mdx b/versioned_docs/version-2.0/reference/subsystems/flake8.mdx index 77b6baf61..48f111059 100644 --- a/versioned_docs/version-2.0/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/grpc_python_plugin.mdx b/versioned_docs/version-2.0/reference/subsystems/grpc_python_plugin.mdx index 91a239003..93abc4ca8 100644 --- a/versioned_docs/version-2.0/reference/subsystems/grpc_python_plugin.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/grpc_python_plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc_python_plugin +description: | + The grpc protobuf plugin for python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/ipython.mdx b/versioned_docs/version-2.0/reference/subsystems/ipython.mdx index 5c7767781..3cb776767 100644 --- a/versioned_docs/version-2.0/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/isort.mdx b/versioned_docs/version-2.0/reference/subsystems/isort.mdx index 71436c246..567028b42 100644 --- a/versioned_docs/version-2.0/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://timothycrosley.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.0/reference/subsystems/lambdex.mdx index 68ae3ac8f..dd724dfd1 100644 --- a/versioned_docs/version-2.0/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into AWS Lambdas (https://github.com/wickman/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/mypy.mdx b/versioned_docs/version-2.0/reference/subsystems/mypy.mdx index fee253a39..4ea4fa5fc 100644 --- a/versioned_docs/version-2.0/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.0/reference/subsystems/pex-binary-defaults.mdx index d9990915f..45ea33386 100644 --- a/versioned_docs/version-2.0/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/pex.mdx b/versioned_docs/version-2.0/reference/subsystems/pex.mdx index ee9d76bb3..ebe711fd8 100644 --- a/versioned_docs/version-2.0/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/protoc.mdx b/versioned_docs/version-2.0/reference/subsystems/protoc.mdx index b53f0d0b6..0320b7197 100644 --- a/versioned_docs/version-2.0/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/pylint.mdx b/versioned_docs/version-2.0/reference/subsystems/pylint.mdx index ff603cdf4..588dfeb52 100644 --- a/versioned_docs/version-2.0/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The PyLint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/pytest.mdx b/versioned_docs/version-2.0/reference/subsystems/pytest.mdx index 54e43a702..0db47c1b2 100644 --- a/versioned_docs/version-2.0/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/python-binary.mdx b/versioned_docs/version-2.0/reference/subsystems/python-binary.mdx index f2dfc81c0..3e6bb48f1 100644 --- a/versioned_docs/version-2.0/reference/subsystems/python-binary.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/python-binary.mdx @@ -1,5 +1,7 @@ --- title: python-binary +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.0/reference/subsystems/python-infer.mdx index 3e66c8772..f04f6654c 100644 --- a/versioned_docs/version-2.0/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.0/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.0/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.0/reference/subsystems/python-protobuf.mdx index b94d74ae1..cdb5390b7 100644 --- a/versioned_docs/version-2.0/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.0/reference/subsystems/python-repos.mdx index 64ed086f0..92f41a299 100644 --- a/versioned_docs/version-2.0/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.0/reference/subsystems/python-setup.mdx index 878433496..cecab3f9e 100644 --- a/versioned_docs/version-2.0/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + A Python environment. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/reporting.mdx b/versioned_docs/version-2.0/reference/subsystems/reporting.mdx index cca86ab8a..3775fee05 100644 --- a/versioned_docs/version-2.0/reference/subsystems/reporting.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/reporting.mdx @@ -1,5 +1,7 @@ --- title: reporting +description: | + V1 reporting config. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/run-tracker.mdx b/versioned_docs/version-2.0/reference/subsystems/run-tracker.mdx index a3c577d10..805c8633f 100644 --- a/versioned_docs/version-2.0/reference/subsystems/run-tracker.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/run-tracker.mdx @@ -1,5 +1,7 @@ --- title: run-tracker +description: | + Tracks and times the execution of a pants run. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/scc.mdx b/versioned_docs/version-2.0/reference/subsystems/scc.mdx index 23c8a5d5d..f8dfa6a5f 100644 --- a/versioned_docs/version-2.0/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.0/reference/subsystems/setup-py-generation.mdx index 5b4cd4e97..8dcae9a51 100644 --- a/versioned_docs/version-2.0/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.0/reference/subsystems/setuptools.mdx index 901fb3bd0..971fe713b 100644 --- a/versioned_docs/version-2.0/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + The Python setuptools library (https://github.com/pypa/setuptools). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/source.mdx b/versioned_docs/version-2.0/reference/subsystems/source.mdx index c013fd363..cdd8f538f 100644 --- a/versioned_docs/version-2.0/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.0/reference/subsystems/sourcefile-validation.mdx index 6e58015a8..8c61abda2 100644 --- a/versioned_docs/version-2.0/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.0/reference/subsystems/subprocess-environment.mdx index 331eacb65..073f5fcc2 100644 --- a/versioned_docs/version-2.0/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.0/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.0/reference/targets/archive.mdx b/versioned_docs/version-2.0/reference/targets/archive.mdx index b813eab1a..3c67ad07f 100644 --- a/versioned_docs/version-2.0/reference/targets/archive.mdx +++ b/versioned_docs/version-2.0/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/files.mdx b/versioned_docs/version-2.0/reference/targets/files.mdx index eae0285f1..9c04de716 100644 --- a/versioned_docs/version-2.0/reference/targets/files.mdx +++ b/versioned_docs/version-2.0/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Loose files that live outside code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/mypy_source_plugin.mdx b/versioned_docs/version-2.0/reference/targets/mypy_source_plugin.mdx index 73ed29265..8ef6696da 100644 --- a/versioned_docs/version-2.0/reference/targets/mypy_source_plugin.mdx +++ b/versioned_docs/version-2.0/reference/targets/mypy_source_plugin.mdx @@ -1,5 +1,7 @@ --- title: mypy_source_plugin +description: | + A MyPy plugin loaded through source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/pex_binary.mdx b/versioned_docs/version-2.0/reference/targets/pex_binary.mdx index db359c7b1..65d6ebb56 100644 --- a/versioned_docs/version-2.0/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.0/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/protobuf_library.mdx b/versioned_docs/version-2.0/reference/targets/protobuf_library.mdx index d983aeae6..2bf56a690 100644 --- a/versioned_docs/version-2.0/reference/targets/protobuf_library.mdx +++ b/versioned_docs/version-2.0/reference/targets/protobuf_library.mdx @@ -1,5 +1,7 @@ --- title: protobuf_library +description: | + Protobuf files used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/pylint_source_plugin.mdx b/versioned_docs/version-2.0/reference/targets/pylint_source_plugin.mdx index face37996..68de43d87 100644 --- a/versioned_docs/version-2.0/reference/targets/pylint_source_plugin.mdx +++ b/versioned_docs/version-2.0/reference/targets/pylint_source_plugin.mdx @@ -1,5 +1,7 @@ --- title: pylint_source_plugin +description: | + A Pylint plugin loaded through source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.0/reference/targets/python_awslambda.mdx index 4d2b1bf13..9b1c16bfa 100644 --- a/versioned_docs/version-2.0/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.0/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/python_distribution.mdx b/versioned_docs/version-2.0/reference/targets/python_distribution.mdx index 34dc4db05..2f723f26f 100644 --- a/versioned_docs/version-2.0/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.0/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/python_library.mdx b/versioned_docs/version-2.0/reference/targets/python_library.mdx index 404d88201..0aef31599 100644 --- a/versioned_docs/version-2.0/reference/targets/python_library.mdx +++ b/versioned_docs/version-2.0/reference/targets/python_library.mdx @@ -1,5 +1,7 @@ --- title: python_library +description: | + Python source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/python_requirement_library.mdx b/versioned_docs/version-2.0/reference/targets/python_requirement_library.mdx index 0fd89720c..4b143c5e8 100644 --- a/versioned_docs/version-2.0/reference/targets/python_requirement_library.mdx +++ b/versioned_docs/version-2.0/reference/targets/python_requirement_library.mdx @@ -1,5 +1,7 @@ --- title: python_requirement_library +description: | + Python requirements installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/python_tests.mdx b/versioned_docs/version-2.0/reference/targets/python_tests.mdx index 564fe8e51..e0bfe651d 100644 --- a/versioned_docs/version-2.0/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.0/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Python tests. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/relocated_files.mdx b/versioned_docs/version-2.0/reference/targets/relocated_files.mdx index 00f618181..9821f5a97 100644 --- a/versioned_docs/version-2.0/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.0/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/resources.mdx b/versioned_docs/version-2.0/reference/targets/resources.mdx index 42ff016a1..3543538f0 100644 --- a/versioned_docs/version-2.0/reference/targets/resources.mdx +++ b/versioned_docs/version-2.0/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Data emebdded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.0/reference/targets/target.mdx b/versioned_docs/version-2.0/reference/targets/target.mdx index 251abc684..cf4633f5f 100644 --- a/versioned_docs/version-2.0/reference/targets/target.mdx +++ b/versioned_docs/version-2.0/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/global-options.mdx b/versioned_docs/version-2.1/reference/global-options.mdx index 067ae27c2..7569172f8 100644 --- a/versioned_docs/version-2.1/reference/global-options.mdx +++ b/versioned_docs/version-2.1/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/count-loc.mdx b/versioned_docs/version-2.1/reference/goals/count-loc.mdx index a3b53e783..06ee32951 100644 --- a/versioned_docs/version-2.1/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.1/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/dependees.mdx b/versioned_docs/version-2.1/reference/goals/dependees.mdx index a0f25c578..d8e604698 100644 --- a/versioned_docs/version-2.1/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.1/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/dependencies.mdx b/versioned_docs/version-2.1/reference/goals/dependencies.mdx index df1a18e07..35ab9042e 100644 --- a/versioned_docs/version-2.1/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.1/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/export-codegen.mdx b/versioned_docs/version-2.1/reference/goals/export-codegen.mdx index 94071e107..c06838cef 100644 --- a/versioned_docs/version-2.1/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.1/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/filedeps.mdx b/versioned_docs/version-2.1/reference/goals/filedeps.mdx index 515489a18..bf3b5b2ae 100644 --- a/versioned_docs/version-2.1/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.1/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/filter.mdx b/versioned_docs/version-2.1/reference/goals/filter.mdx index 75475dc50..c28ce8648 100644 --- a/versioned_docs/version-2.1/reference/goals/filter.mdx +++ b/versioned_docs/version-2.1/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/fmt.mdx b/versioned_docs/version-2.1/reference/goals/fmt.mdx index e5e483329..bf4c978d8 100644 --- a/versioned_docs/version-2.1/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.1/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/lint.mdx b/versioned_docs/version-2.1/reference/goals/lint.mdx index 82cebf39f..95a6cd7dc 100644 --- a/versioned_docs/version-2.1/reference/goals/lint.mdx +++ b/versioned_docs/version-2.1/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/list.mdx b/versioned_docs/version-2.1/reference/goals/list.mdx index a0728060b..255a7d00c 100644 --- a/versioned_docs/version-2.1/reference/goals/list.mdx +++ b/versioned_docs/version-2.1/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/package.mdx b/versioned_docs/version-2.1/reference/goals/package.mdx index 5b6bb28a4..cf288c6b3 100644 --- a/versioned_docs/version-2.1/reference/goals/package.mdx +++ b/versioned_docs/version-2.1/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/repl.mdx b/versioned_docs/version-2.1/reference/goals/repl.mdx index 2b514c49c..b653d8553 100644 --- a/versioned_docs/version-2.1/reference/goals/repl.mdx +++ b/versioned_docs/version-2.1/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/roots.mdx b/versioned_docs/version-2.1/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.1/reference/goals/roots.mdx +++ b/versioned_docs/version-2.1/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/run.mdx b/versioned_docs/version-2.1/reference/goals/run.mdx index 69b22b42a..07d26ed32 100644 --- a/versioned_docs/version-2.1/reference/goals/run.mdx +++ b/versioned_docs/version-2.1/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/test.mdx b/versioned_docs/version-2.1/reference/goals/test.mdx index 0ce95ea0d..725dd6af5 100644 --- a/versioned_docs/version-2.1/reference/goals/test.mdx +++ b/versioned_docs/version-2.1/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/typecheck.mdx b/versioned_docs/version-2.1/reference/goals/typecheck.mdx index 660de7077..6dad17a1c 100644 --- a/versioned_docs/version-2.1/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.1/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checkers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/goals/validate.mdx b/versioned_docs/version-2.1/reference/goals/validate.mdx index 8970dbe36..42e37f2d5 100644 --- a/versioned_docs/version-2.1/reference/goals/validate.mdx +++ b/versioned_docs/version-2.1/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/bandit.mdx b/versioned_docs/version-2.1/reference/subsystems/bandit.mdx index a05214f2c..6e5121954 100644 --- a/versioned_docs/version-2.1/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/black.mdx b/versioned_docs/version-2.1/reference/subsystems/black.mdx index 420ffe609..570cfae50 100644 --- a/versioned_docs/version-2.1/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/changed.mdx b/versioned_docs/version-2.1/reference/subsystems/changed.mdx index ed09fac05..2392db405 100644 --- a/versioned_docs/version-2.1/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.1/reference/subsystems/coverage-py.mdx index e29b8601e..d06ab4aae 100644 --- a/versioned_docs/version-2.1/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.1/reference/subsystems/docformatter.mdx index 9cf767cd3..e5f64d5ae 100644 --- a/versioned_docs/version-2.1/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.1/reference/subsystems/download-pex-bin.mdx index 98a63005a..30086b470 100644 --- a/versioned_docs/version-2.1/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/flake8.mdx b/versioned_docs/version-2.1/reference/subsystems/flake8.mdx index 82bddda15..adffa3cf8 100644 --- a/versioned_docs/version-2.1/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/grpc_python_plugin.mdx b/versioned_docs/version-2.1/reference/subsystems/grpc_python_plugin.mdx index 91a239003..93abc4ca8 100644 --- a/versioned_docs/version-2.1/reference/subsystems/grpc_python_plugin.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/grpc_python_plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc_python_plugin +description: | + The grpc protobuf plugin for python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/ipython.mdx b/versioned_docs/version-2.1/reference/subsystems/ipython.mdx index 96d46d786..4fca68a43 100644 --- a/versioned_docs/version-2.1/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/isort.mdx b/versioned_docs/version-2.1/reference/subsystems/isort.mdx index 71436c246..567028b42 100644 --- a/versioned_docs/version-2.1/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://timothycrosley.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.1/reference/subsystems/lambdex.mdx index 68ae3ac8f..dd724dfd1 100644 --- a/versioned_docs/version-2.1/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into AWS Lambdas (https://github.com/wickman/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/mypy.mdx b/versioned_docs/version-2.1/reference/subsystems/mypy.mdx index fee253a39..4ea4fa5fc 100644 --- a/versioned_docs/version-2.1/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.1/reference/subsystems/pex-binary-defaults.mdx index bb6da8733..b2cb079a1 100644 --- a/versioned_docs/version-2.1/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/pex.mdx b/versioned_docs/version-2.1/reference/subsystems/pex.mdx index ee9d76bb3..ebe711fd8 100644 --- a/versioned_docs/version-2.1/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/protoc.mdx b/versioned_docs/version-2.1/reference/subsystems/protoc.mdx index c5feb3dbf..1c9cd2eb3 100644 --- a/versioned_docs/version-2.1/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/pylint.mdx b/versioned_docs/version-2.1/reference/subsystems/pylint.mdx index 7c7c3a238..d916a4385 100644 --- a/versioned_docs/version-2.1/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The PyLint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/pytest.mdx b/versioned_docs/version-2.1/reference/subsystems/pytest.mdx index 54e43a702..0db47c1b2 100644 --- a/versioned_docs/version-2.1/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.1/reference/subsystems/python-infer.mdx index 3e66c8772..f04f6654c 100644 --- a/versioned_docs/version-2.1/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.1/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.1/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.1/reference/subsystems/python-protobuf.mdx index b94d74ae1..cdb5390b7 100644 --- a/versioned_docs/version-2.1/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.1/reference/subsystems/python-repos.mdx index 64ed086f0..92f41a299 100644 --- a/versioned_docs/version-2.1/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.1/reference/subsystems/python-setup.mdx index cd3d9c44e..5245d0a9d 100644 --- a/versioned_docs/version-2.1/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + A Python environment. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/run-tracker.mdx b/versioned_docs/version-2.1/reference/subsystems/run-tracker.mdx index 1526782ac..733c748f9 100644 --- a/versioned_docs/version-2.1/reference/subsystems/run-tracker.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/run-tracker.mdx @@ -1,5 +1,7 @@ --- title: run-tracker +description: | + Tracks and times the execution of a pants run. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/scc.mdx b/versioned_docs/version-2.1/reference/subsystems/scc.mdx index 23c8a5d5d..f8dfa6a5f 100644 --- a/versioned_docs/version-2.1/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.1/reference/subsystems/setup-py-generation.mdx index 5b4cd4e97..8dcae9a51 100644 --- a/versioned_docs/version-2.1/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.1/reference/subsystems/setuptools.mdx index 901fb3bd0..971fe713b 100644 --- a/versioned_docs/version-2.1/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + The Python setuptools library (https://github.com/pypa/setuptools). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/source.mdx b/versioned_docs/version-2.1/reference/subsystems/source.mdx index 1f3ead43d..637e648f6 100644 --- a/versioned_docs/version-2.1/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.1/reference/subsystems/sourcefile-validation.mdx index 6e58015a8..8c61abda2 100644 --- a/versioned_docs/version-2.1/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.1/reference/subsystems/subprocess-environment.mdx index ec8321783..ff0b92195 100644 --- a/versioned_docs/version-2.1/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.1/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.1/reference/targets/archive.mdx b/versioned_docs/version-2.1/reference/targets/archive.mdx index b813eab1a..3c67ad07f 100644 --- a/versioned_docs/version-2.1/reference/targets/archive.mdx +++ b/versioned_docs/version-2.1/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/files.mdx b/versioned_docs/version-2.1/reference/targets/files.mdx index eae0285f1..9c04de716 100644 --- a/versioned_docs/version-2.1/reference/targets/files.mdx +++ b/versioned_docs/version-2.1/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Loose files that live outside code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/mypy_source_plugin.mdx b/versioned_docs/version-2.1/reference/targets/mypy_source_plugin.mdx index 345e30496..707e38632 100644 --- a/versioned_docs/version-2.1/reference/targets/mypy_source_plugin.mdx +++ b/versioned_docs/version-2.1/reference/targets/mypy_source_plugin.mdx @@ -1,5 +1,7 @@ --- title: mypy_source_plugin +description: | + A MyPy plugin loaded through source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/pex_binary.mdx b/versioned_docs/version-2.1/reference/targets/pex_binary.mdx index 9200cf62a..6b7c92744 100644 --- a/versioned_docs/version-2.1/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.1/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/protobuf_library.mdx b/versioned_docs/version-2.1/reference/targets/protobuf_library.mdx index d6d5cbc6f..48e5b6da4 100644 --- a/versioned_docs/version-2.1/reference/targets/protobuf_library.mdx +++ b/versioned_docs/version-2.1/reference/targets/protobuf_library.mdx @@ -1,5 +1,7 @@ --- title: protobuf_library +description: | + Protobuf files used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/pylint_source_plugin.mdx b/versioned_docs/version-2.1/reference/targets/pylint_source_plugin.mdx index e11336305..58f2b5e11 100644 --- a/versioned_docs/version-2.1/reference/targets/pylint_source_plugin.mdx +++ b/versioned_docs/version-2.1/reference/targets/pylint_source_plugin.mdx @@ -1,5 +1,7 @@ --- title: pylint_source_plugin +description: | + A Pylint plugin loaded through source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.1/reference/targets/python_awslambda.mdx index eab75dc8d..1c7686eca 100644 --- a/versioned_docs/version-2.1/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.1/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/python_distribution.mdx b/versioned_docs/version-2.1/reference/targets/python_distribution.mdx index 34dc4db05..2f723f26f 100644 --- a/versioned_docs/version-2.1/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.1/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/python_library.mdx b/versioned_docs/version-2.1/reference/targets/python_library.mdx index 64a268272..a19c4cf4f 100644 --- a/versioned_docs/version-2.1/reference/targets/python_library.mdx +++ b/versioned_docs/version-2.1/reference/targets/python_library.mdx @@ -1,5 +1,7 @@ --- title: python_library +description: | + Python source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/python_requirement_library.mdx b/versioned_docs/version-2.1/reference/targets/python_requirement_library.mdx index 0fd89720c..4b143c5e8 100644 --- a/versioned_docs/version-2.1/reference/targets/python_requirement_library.mdx +++ b/versioned_docs/version-2.1/reference/targets/python_requirement_library.mdx @@ -1,5 +1,7 @@ --- title: python_requirement_library +description: | + Python requirements installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/python_tests.mdx b/versioned_docs/version-2.1/reference/targets/python_tests.mdx index f5a324bec..46ba0eb1b 100644 --- a/versioned_docs/version-2.1/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.1/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Python tests. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/relocated_files.mdx b/versioned_docs/version-2.1/reference/targets/relocated_files.mdx index 00f618181..9821f5a97 100644 --- a/versioned_docs/version-2.1/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.1/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/resources.mdx b/versioned_docs/version-2.1/reference/targets/resources.mdx index 42ff016a1..3543538f0 100644 --- a/versioned_docs/version-2.1/reference/targets/resources.mdx +++ b/versioned_docs/version-2.1/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Data emebdded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.1/reference/targets/target.mdx b/versioned_docs/version-2.1/reference/targets/target.mdx index 251abc684..cf4633f5f 100644 --- a/versioned_docs/version-2.1/reference/targets/target.mdx +++ b/versioned_docs/version-2.1/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/global-options.mdx b/versioned_docs/version-2.10/reference/global-options.mdx index 8c55996f4..26b443ca1 100644 --- a/versioned_docs/version-2.10/reference/global-options.mdx +++ b/versioned_docs/version-2.10/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/check.mdx b/versioned_docs/version-2.10/reference/goals/check.mdx index cf0932f3e..e1efe42e0 100644 --- a/versioned_docs/version-2.10/reference/goals/check.mdx +++ b/versioned_docs/version-2.10/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/count-loc.mdx b/versioned_docs/version-2.10/reference/goals/count-loc.mdx index 3dfd02327..b107c8064 100644 --- a/versioned_docs/version-2.10/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.10/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/dependees.mdx b/versioned_docs/version-2.10/reference/goals/dependees.mdx index f69e3282e..ed303c66b 100644 --- a/versioned_docs/version-2.10/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.10/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/dependencies.mdx b/versioned_docs/version-2.10/reference/goals/dependencies.mdx index b9acab583..db7ba7478 100644 --- a/versioned_docs/version-2.10/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.10/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.10/reference/goals/experimental-bsp.mdx index e6260ae30..f071a4440 100644 --- a/versioned_docs/version-2.10/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.10/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Run server for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/export-codegen.mdx b/versioned_docs/version-2.10/reference/goals/export-codegen.mdx index 06a6bd502..d4c48f379 100644 --- a/versioned_docs/version-2.10/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.10/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/export.mdx b/versioned_docs/version-2.10/reference/goals/export.mdx index 69b056398..3cf2b01e3 100644 --- a/versioned_docs/version-2.10/reference/goals/export.mdx +++ b/versioned_docs/version-2.10/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/filedeps.mdx b/versioned_docs/version-2.10/reference/goals/filedeps.mdx index 71b150c32..b1556c4ed 100644 --- a/versioned_docs/version-2.10/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.10/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/filter.mdx b/versioned_docs/version-2.10/reference/goals/filter.mdx index 57caac539..8183d3a15 100644 --- a/versioned_docs/version-2.10/reference/goals/filter.mdx +++ b/versioned_docs/version-2.10/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/fmt.mdx b/versioned_docs/version-2.10/reference/goals/fmt.mdx index a2ec50afd..af9d58b81 100644 --- a/versioned_docs/version-2.10/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.10/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.10/reference/goals/generate-lockfiles.mdx index ce33e4677..43cbba3a7 100644 --- a/versioned_docs/version-2.10/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.10/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for Python third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/generate-user-lockfile.mdx b/versioned_docs/version-2.10/reference/goals/generate-user-lockfile.mdx index 88d2050de..995dc0cbb 100644 --- a/versioned_docs/version-2.10/reference/goals/generate-user-lockfile.mdx +++ b/versioned_docs/version-2.10/reference/goals/generate-user-lockfile.mdx @@ -1,5 +1,7 @@ --- title: generate-user-lockfile +description: | + Deprecated: use the option `[python].resolves` and the `generate-lockfiles` goal instead --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/help-advanced.mdx b/versioned_docs/version-2.10/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.10/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.10/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/help-all.mdx b/versioned_docs/version-2.10/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.10/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.10/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/help.mdx b/versioned_docs/version-2.10/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.10/reference/goals/help.mdx +++ b/versioned_docs/version-2.10/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/lint.mdx b/versioned_docs/version-2.10/reference/goals/lint.mdx index 3e1eadafc..831e786f1 100644 --- a/versioned_docs/version-2.10/reference/goals/lint.mdx +++ b/versioned_docs/version-2.10/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/list.mdx b/versioned_docs/version-2.10/reference/goals/list.mdx index 9b417e196..677bd3b46 100644 --- a/versioned_docs/version-2.10/reference/goals/list.mdx +++ b/versioned_docs/version-2.10/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/package.mdx b/versioned_docs/version-2.10/reference/goals/package.mdx index 02088af9f..fe7b10047 100644 --- a/versioned_docs/version-2.10/reference/goals/package.mdx +++ b/versioned_docs/version-2.10/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/paths.mdx b/versioned_docs/version-2.10/reference/goals/paths.mdx index e80b834f5..9feae870c 100644 --- a/versioned_docs/version-2.10/reference/goals/paths.mdx +++ b/versioned_docs/version-2.10/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/peek.mdx b/versioned_docs/version-2.10/reference/goals/peek.mdx index 238dd7197..e8d6c865e 100644 --- a/versioned_docs/version-2.10/reference/goals/peek.mdx +++ b/versioned_docs/version-2.10/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/publish.mdx b/versioned_docs/version-2.10/reference/goals/publish.mdx index cae50adf1..c07dd47ca 100644 --- a/versioned_docs/version-2.10/reference/goals/publish.mdx +++ b/versioned_docs/version-2.10/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/py-constraints.mdx b/versioned_docs/version-2.10/reference/goals/py-constraints.mdx index 54e9f34a5..ee5b26e20 100644 --- a/versioned_docs/version-2.10/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.10/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/repl.mdx b/versioned_docs/version-2.10/reference/goals/repl.mdx index 778911c73..e8dce8f7e 100644 --- a/versioned_docs/version-2.10/reference/goals/repl.mdx +++ b/versioned_docs/version-2.10/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/roots.mdx b/versioned_docs/version-2.10/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.10/reference/goals/roots.mdx +++ b/versioned_docs/version-2.10/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/run.mdx b/versioned_docs/version-2.10/reference/goals/run.mdx index 38b58cf60..d67512188 100644 --- a/versioned_docs/version-2.10/reference/goals/run.mdx +++ b/versioned_docs/version-2.10/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/tailor.mdx b/versioned_docs/version-2.10/reference/goals/tailor.mdx index 11b983fb1..42de9012f 100644 --- a/versioned_docs/version-2.10/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.10/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/test.mdx b/versioned_docs/version-2.10/reference/goals/test.mdx index 6cfe9c098..3cf09835c 100644 --- a/versioned_docs/version-2.10/reference/goals/test.mdx +++ b/versioned_docs/version-2.10/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/update-build-files.mdx b/versioned_docs/version-2.10/reference/goals/update-build-files.mdx index abc322cb6..fe85e0092 100644 --- a/versioned_docs/version-2.10/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.10/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/validate.mdx b/versioned_docs/version-2.10/reference/goals/validate.mdx index 07c35f29a..451ec4d33 100644 --- a/versioned_docs/version-2.10/reference/goals/validate.mdx +++ b/versioned_docs/version-2.10/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Deprecated: to use, set `[regex-lint].config` and run with the `lint` goal --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/goals/version.mdx b/versioned_docs/version-2.10/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.10/reference/goals/version.mdx +++ b/versioned_docs/version-2.10/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.10/reference/subsystems/anonymous-telemetry.mdx index 2502f2c3c..64a55d9e1 100644 --- a/versioned_docs/version-2.10/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.10/reference/subsystems/apache-thrift.mdx index 51347cd8f..5c7e48b0b 100644 --- a/versioned_docs/version-2.10/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.10/reference/subsystems/autoflake.mdx index b5f7d99f4..18a5d6794 100644 --- a/versioned_docs/version-2.10/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/bandit.mdx b/versioned_docs/version-2.10/reference/subsystems/bandit.mdx index 8072844e3..0001b05e9 100644 --- a/versioned_docs/version-2.10/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/black.mdx b/versioned_docs/version-2.10/reference/subsystems/black.mdx index 64deebe01..aed359923 100644 --- a/versioned_docs/version-2.10/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/changed.mdx b/versioned_docs/version-2.10/reference/subsystems/changed.mdx index ef2df969f..9ea6b955f 100644 --- a/versioned_docs/version-2.10/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/cli.mdx b/versioned_docs/version-2.10/reference/subsystems/cli.mdx index 321d918c2..0adf0359c 100644 --- a/versioned_docs/version-2.10/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/coursier.mdx b/versioned_docs/version-2.10/reference/subsystems/coursier.mdx index 46dbf143f..81602d244 100644 --- a/versioned_docs/version-2.10/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.10/reference/subsystems/coverage-py.mdx index 991750e94..74c0db0ae 100644 --- a/versioned_docs/version-2.10/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.10/reference/subsystems/docformatter.mdx index 13fa1eed1..32e6861ae 100644 --- a/versioned_docs/version-2.10/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/docker.mdx b/versioned_docs/version-2.10/reference/subsystems/docker.mdx index 46aa989da..29578b661 100644 --- a/versioned_docs/version-2.10/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.10/reference/subsystems/dockerfile-parser.mdx index 53efaef6a..bd90556d7 100644 --- a/versioned_docs/version-2.10/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.10/reference/subsystems/download-pex-bin.mdx index 69df47f3d..850532728 100644 --- a/versioned_docs/version-2.10/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/flake8.mdx b/versioned_docs/version-2.10/reference/subsystems/flake8.mdx index 08f792169..3632f2b1c 100644 --- a/versioned_docs/version-2.10/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/go-test.mdx b/versioned_docs/version-2.10/reference/subsystems/go-test.mdx index c349091cc..9ae6a7f93 100644 --- a/versioned_docs/version-2.10/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.10/reference/subsystems/gofmt.mdx index 48adb856b..ef6158352 100644 --- a/versioned_docs/version-2.10/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/golang.mdx b/versioned_docs/version-2.10/reference/subsystems/golang.mdx index e822a8af6..82f662cc4 100644 --- a/versioned_docs/version-2.10/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.10/reference/subsystems/google-java-format.mdx index ae5c1b0e3..dd22776ac 100644 --- a/versioned_docs/version-2.10/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.10/reference/subsystems/grpc-python-plugin.mdx index b631f52d6..d08fe81d3 100644 --- a/versioned_docs/version-2.10/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.10/reference/subsystems/hadolint.mdx index e287fc779..e553231a1 100644 --- a/versioned_docs/version-2.10/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/ipython.mdx b/versioned_docs/version-2.10/reference/subsystems/ipython.mdx index 9753a95ea..325a1ec9f 100644 --- a/versioned_docs/version-2.10/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/isort.mdx b/versioned_docs/version-2.10/reference/subsystems/isort.mdx index 5fa59596d..670f6d023 100644 --- a/versioned_docs/version-2.10/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.10/reference/subsystems/java-infer.mdx index 9ed6261f6..7f020184b 100644 --- a/versioned_docs/version-2.10/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/javac.mdx b/versioned_docs/version-2.10/reference/subsystems/javac.mdx index e4cdb2b43..9c4d865fe 100644 --- a/versioned_docs/version-2.10/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/junit.mdx b/versioned_docs/version-2.10/reference/subsystems/junit.mdx index 8c01ea143..bf6d416cc 100644 --- a/versioned_docs/version-2.10/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/jvm.mdx b/versioned_docs/version-2.10/reference/subsystems/jvm.mdx index a616d6f2d..e380537a2 100644 --- a/versioned_docs/version-2.10/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.10/reference/subsystems/lambdex.mdx index f95a55b3b..8a81c5483 100644 --- a/versioned_docs/version-2.10/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.10/reference/subsystems/mypy-protobuf.mdx index 193c6a782..d6272eaf3 100644 --- a/versioned_docs/version-2.10/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/mypy.mdx b/versioned_docs/version-2.10/reference/subsystems/mypy.mdx index 8e621ee3a..f0f4d0031 100644 --- a/versioned_docs/version-2.10/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.10/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.10/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.10/reference/subsystems/pex-cli.mdx index 6c115b419..845bba7a6 100644 --- a/versioned_docs/version-2.10/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/pex.mdx b/versioned_docs/version-2.10/reference/subsystems/pex.mdx index e22060615..8f3730f91 100644 --- a/versioned_docs/version-2.10/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/poetry.mdx b/versioned_docs/version-2.10/reference/subsystems/poetry.mdx index d72eedd31..2582af4d9 100644 --- a/versioned_docs/version-2.10/reference/subsystems/poetry.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/poetry.mdx @@ -1,5 +1,7 @@ --- title: poetry +description: | + Used to generate lockfiles for third-party Python dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/protoc.mdx b/versioned_docs/version-2.10/reference/subsystems/protoc.mdx index f308bee8e..eb33471b5 100644 --- a/versioned_docs/version-2.10/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/pylint.mdx b/versioned_docs/version-2.10/reference/subsystems/pylint.mdx index 9236a4f6c..0bdd5b095 100644 --- a/versioned_docs/version-2.10/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.10/reference/subsystems/pyoxidizer.mdx index 048b207b0..8009db494 100644 --- a/versioned_docs/version-2.10/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/pytest.mdx b/versioned_docs/version-2.10/reference/subsystems/pytest.mdx index 9cacc937c..8e1cef6c4 100644 --- a/versioned_docs/version-2.10/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.10/reference/subsystems/python-bootstrap.mdx index 185479e81..3a75fa3bb 100644 --- a/versioned_docs/version-2.10/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters used by all Pants backends. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.10/reference/subsystems/python-infer.mdx index 484548317..5a3de249b 100644 --- a/versioned_docs/version-2.10/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.10/reference/subsystems/python-native-code.mdx index b20614544..5fd95d1c8 100644 --- a/versioned_docs/version-2.10/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.10/reference/subsystems/python-protobuf.mdx index 8199689ea..e4bd20957 100644 --- a/versioned_docs/version-2.10/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.10/reference/subsystems/python-repos.mdx index 3d1fc03c6..665b4342b 100644 --- a/versioned_docs/version-2.10/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.10/reference/subsystems/python-thrift.mdx index 823ecaa66..78efbb118 100644 --- a/versioned_docs/version-2.10/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/python.mdx b/versioned_docs/version-2.10/reference/subsystems/python.mdx index be4cc3093..6ab34b579 100644 --- a/versioned_docs/version-2.10/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.10/reference/subsystems/pyupgrade.mdx index 161e4bf41..becc53e2c 100644 --- a/versioned_docs/version-2.10/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.10/reference/subsystems/regex-lint.mdx index df1629386..175d51622 100644 --- a/versioned_docs/version-2.10/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.10/reference/subsystems/scala-infer.mdx index 6d5bf38d9..fcdec1f1d 100644 --- a/versioned_docs/version-2.10/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/scala.mdx b/versioned_docs/version-2.10/reference/subsystems/scala.mdx index 5a56a6edf..48f02722e 100644 --- a/versioned_docs/version-2.10/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/scalac.mdx b/versioned_docs/version-2.10/reference/subsystems/scalac.mdx index 4f262354c..c46934768 100644 --- a/versioned_docs/version-2.10/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.10/reference/subsystems/scalafmt.mdx index 27dd5f1ac..5a9ec55c5 100644 --- a/versioned_docs/version-2.10/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.10/reference/subsystems/scalatest.mdx index 5e7303c88..e469766f5 100644 --- a/versioned_docs/version-2.10/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/scc.mdx b/versioned_docs/version-2.10/reference/subsystems/scc.mdx index 5a579f62d..264dc4268 100644 --- a/versioned_docs/version-2.10/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.10/reference/subsystems/setup-py-generation.mdx index 199b4a54f..4b19984ed 100644 --- a/versioned_docs/version-2.10/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.10/reference/subsystems/setuptools.mdx index 9520a1648..7ebc0178a 100644 --- a/versioned_docs/version-2.10/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.10/reference/subsystems/shell-setup.mdx index 2c54ea8e6..f446191dc 100644 --- a/versioned_docs/version-2.10/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.10/reference/subsystems/shellcheck.mdx index 4317bcd35..c7c44ae91 100644 --- a/versioned_docs/version-2.10/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.10/reference/subsystems/shfmt.mdx index d25391d1c..34b4c3a26 100644 --- a/versioned_docs/version-2.10/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/source.mdx b/versioned_docs/version-2.10/reference/subsystems/source.mdx index 80773b631..32b8e0b4b 100644 --- a/versioned_docs/version-2.10/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.10/reference/subsystems/sourcefile-validation.mdx index 29121791d..ea303b42f 100644 --- a/versioned_docs/version-2.10/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/stats.mdx b/versioned_docs/version-2.10/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.10/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.10/reference/subsystems/subprocess-environment.mdx index c2cfcca10..9b4d14d8d 100644 --- a/versioned_docs/version-2.10/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/thrift.mdx b/versioned_docs/version-2.10/reference/subsystems/thrift.mdx index 53a481bec..abf3614f2 100644 --- a/versioned_docs/version-2.10/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/twine.mdx b/versioned_docs/version-2.10/reference/subsystems/twine.mdx index e0d773884..da7ed9c4a 100644 --- a/versioned_docs/version-2.10/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPi and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/subsystems/yapf.mdx b/versioned_docs/version-2.10/reference/subsystems/yapf.mdx index 8ab43a05b..11ae83669 100644 --- a/versioned_docs/version-2.10/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.10/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.10/reference/targets/archive.mdx b/versioned_docs/version-2.10/reference/targets/archive.mdx index ef0cc821c..7e600d229 100644 --- a/versioned_docs/version-2.10/reference/targets/archive.mdx +++ b/versioned_docs/version-2.10/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.10/reference/targets/deploy_jar.mdx index ceaab774c..06b169bd3 100644 --- a/versioned_docs/version-2.10/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.10/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/docker_image.mdx b/versioned_docs/version-2.10/reference/targets/docker_image.mdx index e81fb3673..68a7b34af 100644 --- a/versioned_docs/version-2.10/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.10/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/experimental_run_shell_command.mdx b/versioned_docs/version-2.10/reference/targets/experimental_run_shell_command.mdx index cff78356d..0b918c46f 100644 --- a/versioned_docs/version-2.10/reference/targets/experimental_run_shell_command.mdx +++ b/versioned_docs/version-2.10/reference/targets/experimental_run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/experimental_shell_command.mdx b/versioned_docs/version-2.10/reference/targets/experimental_shell_command.mdx index e4ae87a06..594996bee 100644 --- a/versioned_docs/version-2.10/reference/targets/experimental_shell_command.mdx +++ b/versioned_docs/version-2.10/reference/targets/experimental_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/file.mdx b/versioned_docs/version-2.10/reference/targets/file.mdx index f4b982083..ca6bd061a 100644 --- a/versioned_docs/version-2.10/reference/targets/file.mdx +++ b/versioned_docs/version-2.10/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/files.mdx b/versioned_docs/version-2.10/reference/targets/files.mdx index 27506cf66..119c4fc8a 100644 --- a/versioned_docs/version-2.10/reference/targets/files.mdx +++ b/versioned_docs/version-2.10/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/go_binary.mdx b/versioned_docs/version-2.10/reference/targets/go_binary.mdx index d628f8f35..32f3c9583 100644 --- a/versioned_docs/version-2.10/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.10/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/go_mod.mdx b/versioned_docs/version-2.10/reference/targets/go_mod.mdx index 9ef6738ca..a4d356f7a 100644 --- a/versioned_docs/version-2.10/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.10/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/go_package.mdx b/versioned_docs/version-2.10/reference/targets/go_package.mdx index e2e9c7c39..7eeaebe50 100644 --- a/versioned_docs/version-2.10/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.10/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.10/reference/targets/go_third_party_package.mdx index 7b4719854..1ab85ea95 100644 --- a/versioned_docs/version-2.10/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.10/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/java_source.mdx b/versioned_docs/version-2.10/reference/targets/java_source.mdx index 1e3a8645c..7dfe080cc 100644 --- a/versioned_docs/version-2.10/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.10/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/java_sources.mdx b/versioned_docs/version-2.10/reference/targets/java_sources.mdx index f047c80e3..a086c3432 100644 --- a/versioned_docs/version-2.10/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.10/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/junit_test.mdx b/versioned_docs/version-2.10/reference/targets/junit_test.mdx index c5344af4e..b5dddb684 100644 --- a/versioned_docs/version-2.10/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.10/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/junit_tests.mdx b/versioned_docs/version-2.10/reference/targets/junit_tests.mdx index 297c39d52..07f8d0f2d 100644 --- a/versioned_docs/version-2.10/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.10/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.10/reference/targets/jvm_artifact.mdx index 996e72945..0a35894e0 100644 --- a/versioned_docs/version-2.10/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.10/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.10/reference/targets/pants_requirements.mdx index 67b4b579e..4a0a9d848 100644 --- a/versioned_docs/version-2.10/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.10/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.10/reference/targets/pex_binaries.mdx index 84183d2e3..933fa5389 100644 --- a/versioned_docs/version-2.10/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.10/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/pex_binary.mdx b/versioned_docs/version-2.10/reference/targets/pex_binary.mdx index 8b8d9f397..0f980dbd4 100644 --- a/versioned_docs/version-2.10/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.10/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.10/reference/targets/pipenv_requirements.mdx index e7ec8fdc1..71eb26827 100644 --- a/versioned_docs/version-2.10/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.10/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.10/reference/targets/poetry_requirements.mdx index 4069ccf7e..bb9c62731 100644 --- a/versioned_docs/version-2.10/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.10/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry pyproject.toml. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.10/reference/targets/protobuf_source.mdx index 5f2e6bac8..488209f4b 100644 --- a/versioned_docs/version-2.10/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.10/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.10/reference/targets/protobuf_sources.mdx index e67a55a81..da7db7209 100644 --- a/versioned_docs/version-2.10/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.10/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.10/reference/targets/pyoxidizer_binary.mdx index d7a3a890d..54b7a5b76 100644 --- a/versioned_docs/version-2.10/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.10/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.10/reference/targets/python_awslambda.mdx index 9977ac9dc..44afb95cb 100644 --- a/versioned_docs/version-2.10/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_distribution.mdx b/versioned_docs/version-2.10/reference/targets/python_distribution.mdx index 0b4d7b317..3b072ad7c 100644 --- a/versioned_docs/version-2.10/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.10/reference/targets/python_google_cloud_function.mdx index f4f6b3f7b..a7bd3cc0e 100644 --- a/versioned_docs/version-2.10/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_requirement.mdx b/versioned_docs/version-2.10/reference/targets/python_requirement.mdx index c8edfe27b..d64fd669e 100644 --- a/versioned_docs/version-2.10/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_requirements.mdx b/versioned_docs/version-2.10/reference/targets/python_requirements.mdx index 63649c4fe..af8284e39 100644 --- a/versioned_docs/version-2.10/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_source.mdx b/versioned_docs/version-2.10/reference/targets/python_source.mdx index 22179f211..9b9e764d3 100644 --- a/versioned_docs/version-2.10/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_sources.mdx b/versioned_docs/version-2.10/reference/targets/python_sources.mdx index 7cad237d1..0b1e80d2c 100644 --- a/versioned_docs/version-2.10/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_test.mdx b/versioned_docs/version-2.10/reference/targets/python_test.mdx index 278650475..c9b5824f5 100644 --- a/versioned_docs/version-2.10/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.10/reference/targets/python_test_utils.mdx index d1ad49abe..ec0273062 100644 --- a/versioned_docs/version-2.10/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/python_tests.mdx b/versioned_docs/version-2.10/reference/targets/python_tests.mdx index f740dc113..f9b993edc 100644 --- a/versioned_docs/version-2.10/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.10/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/relocated_files.mdx b/versioned_docs/version-2.10/reference/targets/relocated_files.mdx index 2af795f68..80b992a42 100644 --- a/versioned_docs/version-2.10/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.10/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/resource.mdx b/versioned_docs/version-2.10/reference/targets/resource.mdx index 0de2fb392..b8a8ad01e 100644 --- a/versioned_docs/version-2.10/reference/targets/resource.mdx +++ b/versioned_docs/version-2.10/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/resources.mdx b/versioned_docs/version-2.10/reference/targets/resources.mdx index 8410a80f6..2475f468f 100644 --- a/versioned_docs/version-2.10/reference/targets/resources.mdx +++ b/versioned_docs/version-2.10/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.10/reference/targets/scala_junit_test.mdx index 05e7c3e60..ec67cec76 100644 --- a/versioned_docs/version-2.10/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.10/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.10/reference/targets/scala_junit_tests.mdx index 5e61be5d3..1901bfa92 100644 --- a/versioned_docs/version-2.10/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.10/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/scala_source.mdx b/versioned_docs/version-2.10/reference/targets/scala_source.mdx index aff7c13ae..33a67087f 100644 --- a/versioned_docs/version-2.10/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.10/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/scala_sources.mdx b/versioned_docs/version-2.10/reference/targets/scala_sources.mdx index 391ff9c75..8a6a4be05 100644 --- a/versioned_docs/version-2.10/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.10/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.10/reference/targets/scalac_plugin.mdx index 842173513..09e7a8cc5 100644 --- a/versioned_docs/version-2.10/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.10/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.10/reference/targets/scalatest_test.mdx index 94ac24cbf..a680ac854 100644 --- a/versioned_docs/version-2.10/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.10/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.10/reference/targets/scalatest_tests.mdx index c7064e0cf..5295fbd27 100644 --- a/versioned_docs/version-2.10/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.10/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching ('*Spec.scala', '*Suite.scala')). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/shell_source.mdx b/versioned_docs/version-2.10/reference/targets/shell_source.mdx index d16d70687..618bc1bf4 100644 --- a/versioned_docs/version-2.10/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.10/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/shell_sources.mdx b/versioned_docs/version-2.10/reference/targets/shell_sources.mdx index 8f97109b7..7767dde10 100644 --- a/versioned_docs/version-2.10/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.10/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.10/reference/targets/shunit2_test.mdx index c920abb66..c46d966d8 100644 --- a/versioned_docs/version-2.10/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.10/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.10/reference/targets/shunit2_tests.mdx index 6feaa9c9d..9bc15799f 100644 --- a/versioned_docs/version-2.10/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.10/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/target.mdx b/versioned_docs/version-2.10/reference/targets/target.mdx index bdb72989e..acfac31b3 100644 --- a/versioned_docs/version-2.10/reference/targets/target.mdx +++ b/versioned_docs/version-2.10/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/thrift_source.mdx b/versioned_docs/version-2.10/reference/targets/thrift_source.mdx index e49ee301a..520760004 100644 --- a/versioned_docs/version-2.10/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.10/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.10/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.10/reference/targets/thrift_sources.mdx index 565135058..34f72e947 100644 --- a/versioned_docs/version-2.10/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.10/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/global-options.mdx b/versioned_docs/version-2.11/reference/global-options.mdx index 98169f88b..c0b252c60 100644 --- a/versioned_docs/version-2.11/reference/global-options.mdx +++ b/versioned_docs/version-2.11/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/check.mdx b/versioned_docs/version-2.11/reference/goals/check.mdx index cf0932f3e..e1efe42e0 100644 --- a/versioned_docs/version-2.11/reference/goals/check.mdx +++ b/versioned_docs/version-2.11/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/count-loc.mdx b/versioned_docs/version-2.11/reference/goals/count-loc.mdx index 3dfd02327..b107c8064 100644 --- a/versioned_docs/version-2.11/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.11/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/dependees.mdx b/versioned_docs/version-2.11/reference/goals/dependees.mdx index f69e3282e..ed303c66b 100644 --- a/versioned_docs/version-2.11/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.11/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/dependencies.mdx b/versioned_docs/version-2.11/reference/goals/dependencies.mdx index b9acab583..db7ba7478 100644 --- a/versioned_docs/version-2.11/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.11/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.11/reference/goals/experimental-bsp.mdx index 1970ade61..b2db499bf 100644 --- a/versioned_docs/version-2.11/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.11/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/export-codegen.mdx b/versioned_docs/version-2.11/reference/goals/export-codegen.mdx index 06a6bd502..d4c48f379 100644 --- a/versioned_docs/version-2.11/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.11/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/export.mdx b/versioned_docs/version-2.11/reference/goals/export.mdx index 69b056398..3cf2b01e3 100644 --- a/versioned_docs/version-2.11/reference/goals/export.mdx +++ b/versioned_docs/version-2.11/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/filedeps.mdx b/versioned_docs/version-2.11/reference/goals/filedeps.mdx index 71b150c32..b1556c4ed 100644 --- a/versioned_docs/version-2.11/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.11/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/filter.mdx b/versioned_docs/version-2.11/reference/goals/filter.mdx index 57caac539..8183d3a15 100644 --- a/versioned_docs/version-2.11/reference/goals/filter.mdx +++ b/versioned_docs/version-2.11/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/fmt.mdx b/versioned_docs/version-2.11/reference/goals/fmt.mdx index a9104ad01..9a5105164 100644 --- a/versioned_docs/version-2.11/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.11/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.11/reference/goals/generate-lockfiles.mdx index 4b9e3e4ea..8d4b691bd 100644 --- a/versioned_docs/version-2.11/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.11/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for Python third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/help-advanced.mdx b/versioned_docs/version-2.11/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.11/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.11/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/help-all.mdx b/versioned_docs/version-2.11/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.11/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.11/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/help.mdx b/versioned_docs/version-2.11/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.11/reference/goals/help.mdx +++ b/versioned_docs/version-2.11/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/lint.mdx b/versioned_docs/version-2.11/reference/goals/lint.mdx index 3d4bcbad1..3966c2a77 100644 --- a/versioned_docs/version-2.11/reference/goals/lint.mdx +++ b/versioned_docs/version-2.11/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/list.mdx b/versioned_docs/version-2.11/reference/goals/list.mdx index 9b417e196..677bd3b46 100644 --- a/versioned_docs/version-2.11/reference/goals/list.mdx +++ b/versioned_docs/version-2.11/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/package.mdx b/versioned_docs/version-2.11/reference/goals/package.mdx index 02088af9f..fe7b10047 100644 --- a/versioned_docs/version-2.11/reference/goals/package.mdx +++ b/versioned_docs/version-2.11/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/paths.mdx b/versioned_docs/version-2.11/reference/goals/paths.mdx index 12671c3eb..137fda0cd 100644 --- a/versioned_docs/version-2.11/reference/goals/paths.mdx +++ b/versioned_docs/version-2.11/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/peek.mdx b/versioned_docs/version-2.11/reference/goals/peek.mdx index 238dd7197..e8d6c865e 100644 --- a/versioned_docs/version-2.11/reference/goals/peek.mdx +++ b/versioned_docs/version-2.11/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/publish.mdx b/versioned_docs/version-2.11/reference/goals/publish.mdx index cae50adf1..c07dd47ca 100644 --- a/versioned_docs/version-2.11/reference/goals/publish.mdx +++ b/versioned_docs/version-2.11/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/py-constraints.mdx b/versioned_docs/version-2.11/reference/goals/py-constraints.mdx index 54e9f34a5..ee5b26e20 100644 --- a/versioned_docs/version-2.11/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.11/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/repl.mdx b/versioned_docs/version-2.11/reference/goals/repl.mdx index 778911c73..e8dce8f7e 100644 --- a/versioned_docs/version-2.11/reference/goals/repl.mdx +++ b/versioned_docs/version-2.11/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/roots.mdx b/versioned_docs/version-2.11/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.11/reference/goals/roots.mdx +++ b/versioned_docs/version-2.11/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/run.mdx b/versioned_docs/version-2.11/reference/goals/run.mdx index 659801f07..abcdbdee1 100644 --- a/versioned_docs/version-2.11/reference/goals/run.mdx +++ b/versioned_docs/version-2.11/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/tailor.mdx b/versioned_docs/version-2.11/reference/goals/tailor.mdx index 2b648b7b8..0622ab430 100644 --- a/versioned_docs/version-2.11/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.11/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/test.mdx b/versioned_docs/version-2.11/reference/goals/test.mdx index 6cfe9c098..3cf09835c 100644 --- a/versioned_docs/version-2.11/reference/goals/test.mdx +++ b/versioned_docs/version-2.11/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/update-build-files.mdx b/versioned_docs/version-2.11/reference/goals/update-build-files.mdx index 13781063b..4a86c9969 100644 --- a/versioned_docs/version-2.11/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.11/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/goals/version.mdx b/versioned_docs/version-2.11/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.11/reference/goals/version.mdx +++ b/versioned_docs/version-2.11/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.11/reference/subsystems/anonymous-telemetry.mdx index e0d04efc8..d3a14a72a 100644 --- a/versioned_docs/version-2.11/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.11/reference/subsystems/apache-thrift.mdx index 32fe0a891..2b9ce0a09 100644 --- a/versioned_docs/version-2.11/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.11/reference/subsystems/autoflake.mdx index c7b483c70..c018ce73e 100644 --- a/versioned_docs/version-2.11/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/bandit.mdx b/versioned_docs/version-2.11/reference/subsystems/bandit.mdx index cf9ba32a7..c98a88976 100644 --- a/versioned_docs/version-2.11/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/black.mdx b/versioned_docs/version-2.11/reference/subsystems/black.mdx index 83f1d4542..c55eacb31 100644 --- a/versioned_docs/version-2.11/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/buf.mdx b/versioned_docs/version-2.11/reference/subsystems/buf.mdx index 291323c25..d96d9f55c 100644 --- a/versioned_docs/version-2.11/reference/subsystems/buf.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/changed.mdx b/versioned_docs/version-2.11/reference/subsystems/changed.mdx index a2cb812a3..84653cbae 100644 --- a/versioned_docs/version-2.11/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/cli.mdx b/versioned_docs/version-2.11/reference/subsystems/cli.mdx index 3986b326d..781078c12 100644 --- a/versioned_docs/version-2.11/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/coursier.mdx b/versioned_docs/version-2.11/reference/subsystems/coursier.mdx index 21933a95a..a769ee444 100644 --- a/versioned_docs/version-2.11/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.11/reference/subsystems/coverage-py.mdx index 4adc86a6a..320969d1e 100644 --- a/versioned_docs/version-2.11/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.11/reference/subsystems/docformatter.mdx index fcf8daac0..83eac72b6 100644 --- a/versioned_docs/version-2.11/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/docker.mdx b/versioned_docs/version-2.11/reference/subsystems/docker.mdx index a26e6d127..2a7b4f03d 100644 --- a/versioned_docs/version-2.11/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.11/reference/subsystems/dockerfile-parser.mdx index b0127b9ae..763dfb836 100644 --- a/versioned_docs/version-2.11/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/download-terraform.mdx b/versioned_docs/version-2.11/reference/subsystems/download-terraform.mdx index 1be1f25a0..e32a08787 100644 --- a/versioned_docs/version-2.11/reference/subsystems/download-terraform.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/flake8.mdx b/versioned_docs/version-2.11/reference/subsystems/flake8.mdx index 41ee19536..b934aa28f 100644 --- a/versioned_docs/version-2.11/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/go-test.mdx b/versioned_docs/version-2.11/reference/subsystems/go-test.mdx index 9252a1705..5cabdcf16 100644 --- a/versioned_docs/version-2.11/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.11/reference/subsystems/gofmt.mdx index 48adb856b..ef6158352 100644 --- a/versioned_docs/version-2.11/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/golang.mdx b/versioned_docs/version-2.11/reference/subsystems/golang.mdx index 9f0765174..24e35dc7d 100644 --- a/versioned_docs/version-2.11/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.11/reference/subsystems/google-java-format.mdx index 0ac18dd03..28954d10f 100644 --- a/versioned_docs/version-2.11/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.11/reference/subsystems/grpc-python-plugin.mdx index 585e06917..7c121d958 100644 --- a/versioned_docs/version-2.11/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.11/reference/subsystems/hadolint.mdx index 619e57d26..813316ce6 100644 --- a/versioned_docs/version-2.11/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/helm.mdx b/versioned_docs/version-2.11/reference/subsystems/helm.mdx index d842ce6aa..047d8711c 100644 --- a/versioned_docs/version-2.11/reference/subsystems/helm.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/ipython.mdx b/versioned_docs/version-2.11/reference/subsystems/ipython.mdx index 055dec166..fe14a454e 100644 --- a/versioned_docs/version-2.11/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/isort.mdx b/versioned_docs/version-2.11/reference/subsystems/isort.mdx index 3db00a2de..70f4a6c48 100644 --- a/versioned_docs/version-2.11/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.11/reference/subsystems/java-infer.mdx index 9ed6261f6..7f020184b 100644 --- a/versioned_docs/version-2.11/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/javac.mdx b/versioned_docs/version-2.11/reference/subsystems/javac.mdx index 39c0a356c..742979cf0 100644 --- a/versioned_docs/version-2.11/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/junit.mdx b/versioned_docs/version-2.11/reference/subsystems/junit.mdx index da69470c8..05117fae9 100644 --- a/versioned_docs/version-2.11/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/jvm.mdx b/versioned_docs/version-2.11/reference/subsystems/jvm.mdx index c14f94b24..ef3153e4e 100644 --- a/versioned_docs/version-2.11/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.11/reference/subsystems/lambdex.mdx index 46aad3bd3..ed2298035 100644 --- a/versioned_docs/version-2.11/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.11/reference/subsystems/mypy-protobuf.mdx index b6c890236..f4cd5f109 100644 --- a/versioned_docs/version-2.11/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/mypy.mdx b/versioned_docs/version-2.11/reference/subsystems/mypy.mdx index dc98b7112..35e45b3e8 100644 --- a/versioned_docs/version-2.11/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.11/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.11/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.11/reference/subsystems/pex-cli.mdx index 7eb0b348b..462c585f6 100644 --- a/versioned_docs/version-2.11/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/pex.mdx b/versioned_docs/version-2.11/reference/subsystems/pex.mdx index 070116ce0..cec7d1966 100644 --- a/versioned_docs/version-2.11/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/poetry.mdx b/versioned_docs/version-2.11/reference/subsystems/poetry.mdx index 338ef33ba..7bdc79139 100644 --- a/versioned_docs/version-2.11/reference/subsystems/poetry.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/poetry.mdx @@ -1,5 +1,7 @@ --- title: poetry +description: | + Used to generate lockfiles for third-party Python dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/protoc.mdx b/versioned_docs/version-2.11/reference/subsystems/protoc.mdx index a1bf249fa..a3f05050c 100644 --- a/versioned_docs/version-2.11/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/pylint.mdx b/versioned_docs/version-2.11/reference/subsystems/pylint.mdx index 0f261ca3a..a28bc03a0 100644 --- a/versioned_docs/version-2.11/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.11/reference/subsystems/pyoxidizer.mdx index 3b618d760..c36c3ca7a 100644 --- a/versioned_docs/version-2.11/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/pytest.mdx b/versioned_docs/version-2.11/reference/subsystems/pytest.mdx index a148245dc..71d12fdee 100644 --- a/versioned_docs/version-2.11/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.11/reference/subsystems/python-bootstrap.mdx index 185479e81..3a75fa3bb 100644 --- a/versioned_docs/version-2.11/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters used by all Pants backends. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.11/reference/subsystems/python-infer.mdx index 84cf922df..ecbaf5e14 100644 --- a/versioned_docs/version-2.11/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.11/reference/subsystems/python-native-code.mdx index b20614544..5fd95d1c8 100644 --- a/versioned_docs/version-2.11/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.11/reference/subsystems/python-protobuf.mdx index 6eca04386..3a1832cc7 100644 --- a/versioned_docs/version-2.11/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.11/reference/subsystems/python-repos.mdx index 3d1fc03c6..665b4342b 100644 --- a/versioned_docs/version-2.11/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.11/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/versioned_docs/version-2.11/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/python.mdx b/versioned_docs/version-2.11/reference/subsystems/python.mdx index 8541d3153..4e7ffd4d2 100644 --- a/versioned_docs/version-2.11/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.11/reference/subsystems/pyupgrade.mdx index 14b670a97..c2dfa06a8 100644 --- a/versioned_docs/version-2.11/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.11/reference/subsystems/regex-lint.mdx index df1629386..175d51622 100644 --- a/versioned_docs/version-2.11/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.11/reference/subsystems/scala-infer.mdx index 6d5bf38d9..fcdec1f1d 100644 --- a/versioned_docs/version-2.11/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/scala.mdx b/versioned_docs/version-2.11/reference/subsystems/scala.mdx index 78056aca5..5d6628858 100644 --- a/versioned_docs/version-2.11/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/scalac.mdx b/versioned_docs/version-2.11/reference/subsystems/scalac.mdx index f4ed82b3e..549209377 100644 --- a/versioned_docs/version-2.11/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.11/reference/subsystems/scalafmt.mdx index 99f5d5fdf..a6950a7b5 100644 --- a/versioned_docs/version-2.11/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.11/reference/subsystems/scalapb.mdx index 544dca44e..bdbd216dc 100644 --- a/versioned_docs/version-2.11/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.11/reference/subsystems/scalatest.mdx index a9d3e20c6..b18151665 100644 --- a/versioned_docs/version-2.11/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/scc.mdx b/versioned_docs/version-2.11/reference/subsystems/scc.mdx index 158ef0c0c..815c9f0a8 100644 --- a/versioned_docs/version-2.11/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.11/reference/subsystems/setup-py-generation.mdx index 199b4a54f..4b19984ed 100644 --- a/versioned_docs/version-2.11/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.11/reference/subsystems/setuptools.mdx index 4db22c6d3..c48135a53 100644 --- a/versioned_docs/version-2.11/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.11/reference/subsystems/shell-setup.mdx index 2bf26331b..5e0755245 100644 --- a/versioned_docs/version-2.11/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.11/reference/subsystems/shellcheck.mdx index 1e98ef1f9..7f421e1b4 100644 --- a/versioned_docs/version-2.11/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.11/reference/subsystems/shfmt.mdx index 2d9add14b..09d7cc93f 100644 --- a/versioned_docs/version-2.11/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/source.mdx b/versioned_docs/version-2.11/reference/subsystems/source.mdx index f07b2dbc5..562804bc1 100644 --- a/versioned_docs/version-2.11/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/stats.mdx b/versioned_docs/version-2.11/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.11/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.11/reference/subsystems/subprocess-environment.mdx index 2f4aada28..043d5d37c 100644 --- a/versioned_docs/version-2.11/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/terraform-fmt.mdx b/versioned_docs/version-2.11/reference/subsystems/terraform-fmt.mdx index 70511ac58..500597b9e 100644 --- a/versioned_docs/version-2.11/reference/subsystems/terraform-fmt.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/terraform-hcl2-parser.mdx b/versioned_docs/version-2.11/reference/subsystems/terraform-hcl2-parser.mdx index 32aae8251..55f5dff2a 100644 --- a/versioned_docs/version-2.11/reference/subsystems/terraform-hcl2-parser.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/terraform-validate.mdx b/versioned_docs/version-2.11/reference/subsystems/terraform-validate.mdx index befc5252a..544d2ad9b 100644 --- a/versioned_docs/version-2.11/reference/subsystems/terraform-validate.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/thrift.mdx b/versioned_docs/version-2.11/reference/subsystems/thrift.mdx index 53a481bec..abf3614f2 100644 --- a/versioned_docs/version-2.11/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/twine.mdx b/versioned_docs/version-2.11/reference/subsystems/twine.mdx index 5f47cf91f..6ab1e93b9 100644 --- a/versioned_docs/version-2.11/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPi and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/subsystems/yapf.mdx b/versioned_docs/version-2.11/reference/subsystems/yapf.mdx index 05c87b287..dd5b74e71 100644 --- a/versioned_docs/version-2.11/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.11/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.11/reference/targets/archive.mdx b/versioned_docs/version-2.11/reference/targets/archive.mdx index 801685458..921bde6e0 100644 --- a/versioned_docs/version-2.11/reference/targets/archive.mdx +++ b/versioned_docs/version-2.11/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.11/reference/targets/deploy_jar.mdx index 5fccca533..14aa5f097 100644 --- a/versioned_docs/version-2.11/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.11/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/docker_image.mdx b/versioned_docs/version-2.11/reference/targets/docker_image.mdx index 7583625bc..d6b7d8bb7 100644 --- a/versioned_docs/version-2.11/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.11/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/experimental_run_shell_command.mdx b/versioned_docs/version-2.11/reference/targets/experimental_run_shell_command.mdx index 874b73543..5b8ba18be 100644 --- a/versioned_docs/version-2.11/reference/targets/experimental_run_shell_command.mdx +++ b/versioned_docs/version-2.11/reference/targets/experimental_run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/experimental_shell_command.mdx b/versioned_docs/version-2.11/reference/targets/experimental_shell_command.mdx index b07d86f3f..6dc44143f 100644 --- a/versioned_docs/version-2.11/reference/targets/experimental_shell_command.mdx +++ b/versioned_docs/version-2.11/reference/targets/experimental_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/file.mdx b/versioned_docs/version-2.11/reference/targets/file.mdx index 4966422b0..6dc7977c3 100644 --- a/versioned_docs/version-2.11/reference/targets/file.mdx +++ b/versioned_docs/version-2.11/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/files.mdx b/versioned_docs/version-2.11/reference/targets/files.mdx index 3916bf5de..aa8877d5b 100644 --- a/versioned_docs/version-2.11/reference/targets/files.mdx +++ b/versioned_docs/version-2.11/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/go_binary.mdx b/versioned_docs/version-2.11/reference/targets/go_binary.mdx index 26351b1ff..9b710af9a 100644 --- a/versioned_docs/version-2.11/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.11/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/go_mod.mdx b/versioned_docs/version-2.11/reference/targets/go_mod.mdx index caeac0e75..0ab3a00d5 100644 --- a/versioned_docs/version-2.11/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.11/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/go_package.mdx b/versioned_docs/version-2.11/reference/targets/go_package.mdx index a11b5b419..42b273493 100644 --- a/versioned_docs/version-2.11/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.11/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.11/reference/targets/go_third_party_package.mdx index 3dea74496..ad9af1b30 100644 --- a/versioned_docs/version-2.11/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.11/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/helm_chart.mdx b/versioned_docs/version-2.11/reference/targets/helm_chart.mdx index 54f5c679b..6b5a842b1 100644 --- a/versioned_docs/version-2.11/reference/targets/helm_chart.mdx +++ b/versioned_docs/version-2.11/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/java_source.mdx b/versioned_docs/version-2.11/reference/targets/java_source.mdx index e566d7228..3d97e9d01 100644 --- a/versioned_docs/version-2.11/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.11/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/java_sources.mdx b/versioned_docs/version-2.11/reference/targets/java_sources.mdx index d6a815f47..228df4c1b 100644 --- a/versioned_docs/version-2.11/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.11/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/junit_test.mdx b/versioned_docs/version-2.11/reference/targets/junit_test.mdx index 15071c6c8..1b510c87a 100644 --- a/versioned_docs/version-2.11/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.11/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/junit_tests.mdx b/versioned_docs/version-2.11/reference/targets/junit_tests.mdx index 7e454997b..61b54c7bd 100644 --- a/versioned_docs/version-2.11/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.11/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.11/reference/targets/jvm_artifact.mdx index 8770aaf7b..2caad0819 100644 --- a/versioned_docs/version-2.11/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.11/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/jvm_war.mdx b/versioned_docs/version-2.11/reference/targets/jvm_war.mdx index 97ec21a70..6707e4770 100644 --- a/versioned_docs/version-2.11/reference/targets/jvm_war.mdx +++ b/versioned_docs/version-2.11/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.11/reference/targets/pants_requirements.mdx index e3db65610..d62dc158b 100644 --- a/versioned_docs/version-2.11/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.11/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.11/reference/targets/pex_binaries.mdx index af5795761..53e7459d1 100644 --- a/versioned_docs/version-2.11/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.11/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/pex_binary.mdx b/versioned_docs/version-2.11/reference/targets/pex_binary.mdx index 3b7a8d753..2bdc91629 100644 --- a/versioned_docs/version-2.11/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.11/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.11/reference/targets/pipenv_requirements.mdx index ac468ba54..a6ebfe6fe 100644 --- a/versioned_docs/version-2.11/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.11/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.11/reference/targets/poetry_requirements.mdx index 30bf28543..683ec811c 100644 --- a/versioned_docs/version-2.11/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.11/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry pyproject.toml. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.11/reference/targets/protobuf_source.mdx index 1fa649318..fd9935dfe 100644 --- a/versioned_docs/version-2.11/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.11/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.11/reference/targets/protobuf_sources.mdx index f27d77874..227e77b2e 100644 --- a/versioned_docs/version-2.11/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.11/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.11/reference/targets/pyoxidizer_binary.mdx index a78052950..37f5321fc 100644 --- a/versioned_docs/version-2.11/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.11/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.11/reference/targets/python_awslambda.mdx index 5221c53a5..2bfbf7ec9 100644 --- a/versioned_docs/version-2.11/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_distribution.mdx b/versioned_docs/version-2.11/reference/targets/python_distribution.mdx index bf6df82f6..a510e9f96 100644 --- a/versioned_docs/version-2.11/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.11/reference/targets/python_google_cloud_function.mdx index 47e5cc797..a07b3c1bb 100644 --- a/versioned_docs/version-2.11/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_requirement.mdx b/versioned_docs/version-2.11/reference/targets/python_requirement.mdx index 28bd38d90..67b37eb8d 100644 --- a/versioned_docs/version-2.11/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_requirements.mdx b/versioned_docs/version-2.11/reference/targets/python_requirements.mdx index 73dbabfc2..7d813665c 100644 --- a/versioned_docs/version-2.11/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_source.mdx b/versioned_docs/version-2.11/reference/targets/python_source.mdx index 9761bc430..1566e56b5 100644 --- a/versioned_docs/version-2.11/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_sources.mdx b/versioned_docs/version-2.11/reference/targets/python_sources.mdx index 2b0a495b8..0170b93af 100644 --- a/versioned_docs/version-2.11/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_test.mdx b/versioned_docs/version-2.11/reference/targets/python_test.mdx index a33818c1d..5795fe012 100644 --- a/versioned_docs/version-2.11/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.11/reference/targets/python_test_utils.mdx index b7a3447e2..5f3cac25d 100644 --- a/versioned_docs/version-2.11/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/python_tests.mdx b/versioned_docs/version-2.11/reference/targets/python_tests.mdx index f093c82cc..2e2385ae9 100644 --- a/versioned_docs/version-2.11/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.11/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/relocated_files.mdx b/versioned_docs/version-2.11/reference/targets/relocated_files.mdx index b920f40cd..27951f1bf 100644 --- a/versioned_docs/version-2.11/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.11/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/resource.mdx b/versioned_docs/version-2.11/reference/targets/resource.mdx index 68152301f..64b9e59e4 100644 --- a/versioned_docs/version-2.11/reference/targets/resource.mdx +++ b/versioned_docs/version-2.11/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/resources.mdx b/versioned_docs/version-2.11/reference/targets/resources.mdx index 659ff2d46..7a2f44be6 100644 --- a/versioned_docs/version-2.11/reference/targets/resources.mdx +++ b/versioned_docs/version-2.11/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.11/reference/targets/scala_junit_test.mdx index e2fdbbeab..9c759b725 100644 --- a/versioned_docs/version-2.11/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.11/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.11/reference/targets/scala_junit_tests.mdx index 72fae4e86..535401c06 100644 --- a/versioned_docs/version-2.11/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.11/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/scala_source.mdx b/versioned_docs/version-2.11/reference/targets/scala_source.mdx index 06745d7a7..332ec6638 100644 --- a/versioned_docs/version-2.11/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.11/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/scala_sources.mdx b/versioned_docs/version-2.11/reference/targets/scala_sources.mdx index 293b301dc..b271dc9de 100644 --- a/versioned_docs/version-2.11/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.11/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.11/reference/targets/scalac_plugin.mdx index 2d5fa0e60..8253ded67 100644 --- a/versioned_docs/version-2.11/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.11/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.11/reference/targets/scalatest_test.mdx index b90a50990..5f191c24a 100644 --- a/versioned_docs/version-2.11/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.11/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.11/reference/targets/scalatest_tests.mdx index 2eab8a3e7..90146911c 100644 --- a/versioned_docs/version-2.11/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.11/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching ('*Spec.scala', '*Suite.scala')). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/shell_source.mdx b/versioned_docs/version-2.11/reference/targets/shell_source.mdx index 576500bf0..609a77290 100644 --- a/versioned_docs/version-2.11/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.11/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/shell_sources.mdx b/versioned_docs/version-2.11/reference/targets/shell_sources.mdx index 9827060a3..1e1e750ce 100644 --- a/versioned_docs/version-2.11/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.11/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.11/reference/targets/shunit2_test.mdx index 5167da6d7..34ce6c316 100644 --- a/versioned_docs/version-2.11/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.11/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.11/reference/targets/shunit2_tests.mdx index d79bd6151..61775bb26 100644 --- a/versioned_docs/version-2.11/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.11/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/target.mdx b/versioned_docs/version-2.11/reference/targets/target.mdx index 5bc7335d0..3c322343c 100644 --- a/versioned_docs/version-2.11/reference/targets/target.mdx +++ b/versioned_docs/version-2.11/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/terraform_module.mdx b/versioned_docs/version-2.11/reference/targets/terraform_module.mdx index c0ff34a11..6ef8d2104 100644 --- a/versioned_docs/version-2.11/reference/targets/terraform_module.mdx +++ b/versioned_docs/version-2.11/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/thrift_source.mdx b/versioned_docs/version-2.11/reference/targets/thrift_source.mdx index e66ed9156..c8e94e052 100644 --- a/versioned_docs/version-2.11/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.11/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.11/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.11/reference/targets/thrift_sources.mdx index 83dfbb4e8..048310a3e 100644 --- a/versioned_docs/version-2.11/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.11/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/global-options.mdx b/versioned_docs/version-2.12/reference/global-options.mdx index aca4b856a..36bab231b 100644 --- a/versioned_docs/version-2.12/reference/global-options.mdx +++ b/versioned_docs/version-2.12/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/check.mdx b/versioned_docs/version-2.12/reference/goals/check.mdx index cf0932f3e..e1efe42e0 100644 --- a/versioned_docs/version-2.12/reference/goals/check.mdx +++ b/versioned_docs/version-2.12/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/count-loc.mdx b/versioned_docs/version-2.12/reference/goals/count-loc.mdx index 3dfd02327..b107c8064 100644 --- a/versioned_docs/version-2.12/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.12/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/dependees.mdx b/versioned_docs/version-2.12/reference/goals/dependees.mdx index f69e3282e..ed303c66b 100644 --- a/versioned_docs/version-2.12/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.12/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/dependencies.mdx b/versioned_docs/version-2.12/reference/goals/dependencies.mdx index b9acab583..db7ba7478 100644 --- a/versioned_docs/version-2.12/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.12/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.12/reference/goals/experimental-bsp.mdx index 43b3b3123..8747d33cb 100644 --- a/versioned_docs/version-2.12/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.12/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/export-codegen.mdx b/versioned_docs/version-2.12/reference/goals/export-codegen.mdx index 06a6bd502..d4c48f379 100644 --- a/versioned_docs/version-2.12/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.12/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/export.mdx b/versioned_docs/version-2.12/reference/goals/export.mdx index 69b056398..3cf2b01e3 100644 --- a/versioned_docs/version-2.12/reference/goals/export.mdx +++ b/versioned_docs/version-2.12/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/filedeps.mdx b/versioned_docs/version-2.12/reference/goals/filedeps.mdx index 71b150c32..b1556c4ed 100644 --- a/versioned_docs/version-2.12/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.12/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/filter.mdx b/versioned_docs/version-2.12/reference/goals/filter.mdx index 57caac539..8183d3a15 100644 --- a/versioned_docs/version-2.12/reference/goals/filter.mdx +++ b/versioned_docs/version-2.12/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/fmt.mdx b/versioned_docs/version-2.12/reference/goals/fmt.mdx index a9104ad01..9a5105164 100644 --- a/versioned_docs/version-2.12/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.12/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.12/reference/goals/generate-lockfiles.mdx index 4b9e3e4ea..8d4b691bd 100644 --- a/versioned_docs/version-2.12/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.12/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for Python third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/help-advanced.mdx b/versioned_docs/version-2.12/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.12/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.12/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/help-all.mdx b/versioned_docs/version-2.12/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.12/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.12/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/help.mdx b/versioned_docs/version-2.12/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.12/reference/goals/help.mdx +++ b/versioned_docs/version-2.12/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/lint.mdx b/versioned_docs/version-2.12/reference/goals/lint.mdx index 3d4bcbad1..3966c2a77 100644 --- a/versioned_docs/version-2.12/reference/goals/lint.mdx +++ b/versioned_docs/version-2.12/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/list.mdx b/versioned_docs/version-2.12/reference/goals/list.mdx index 9b417e196..677bd3b46 100644 --- a/versioned_docs/version-2.12/reference/goals/list.mdx +++ b/versioned_docs/version-2.12/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/package.mdx b/versioned_docs/version-2.12/reference/goals/package.mdx index 02088af9f..fe7b10047 100644 --- a/versioned_docs/version-2.12/reference/goals/package.mdx +++ b/versioned_docs/version-2.12/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/paths.mdx b/versioned_docs/version-2.12/reference/goals/paths.mdx index 12671c3eb..137fda0cd 100644 --- a/versioned_docs/version-2.12/reference/goals/paths.mdx +++ b/versioned_docs/version-2.12/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/peek.mdx b/versioned_docs/version-2.12/reference/goals/peek.mdx index 238dd7197..e8d6c865e 100644 --- a/versioned_docs/version-2.12/reference/goals/peek.mdx +++ b/versioned_docs/version-2.12/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/publish.mdx b/versioned_docs/version-2.12/reference/goals/publish.mdx index cae50adf1..c07dd47ca 100644 --- a/versioned_docs/version-2.12/reference/goals/publish.mdx +++ b/versioned_docs/version-2.12/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/py-constraints.mdx b/versioned_docs/version-2.12/reference/goals/py-constraints.mdx index 54e9f34a5..ee5b26e20 100644 --- a/versioned_docs/version-2.12/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.12/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/repl.mdx b/versioned_docs/version-2.12/reference/goals/repl.mdx index 778911c73..e8dce8f7e 100644 --- a/versioned_docs/version-2.12/reference/goals/repl.mdx +++ b/versioned_docs/version-2.12/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/roots.mdx b/versioned_docs/version-2.12/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.12/reference/goals/roots.mdx +++ b/versioned_docs/version-2.12/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/run.mdx b/versioned_docs/version-2.12/reference/goals/run.mdx index 659801f07..abcdbdee1 100644 --- a/versioned_docs/version-2.12/reference/goals/run.mdx +++ b/versioned_docs/version-2.12/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/tailor.mdx b/versioned_docs/version-2.12/reference/goals/tailor.mdx index 3abb3e485..d8d6688e9 100644 --- a/versioned_docs/version-2.12/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.12/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/test.mdx b/versioned_docs/version-2.12/reference/goals/test.mdx index 69c498120..429cfb5a1 100644 --- a/versioned_docs/version-2.12/reference/goals/test.mdx +++ b/versioned_docs/version-2.12/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/update-build-files.mdx b/versioned_docs/version-2.12/reference/goals/update-build-files.mdx index ed399117f..c608b9ebb 100644 --- a/versioned_docs/version-2.12/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.12/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/goals/version.mdx b/versioned_docs/version-2.12/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.12/reference/goals/version.mdx +++ b/versioned_docs/version-2.12/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.12/reference/subsystems/anonymous-telemetry.mdx index a8a66bdfe..936877210 100644 --- a/versioned_docs/version-2.12/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.12/reference/subsystems/apache-thrift.mdx index 32fe0a891..2b9ce0a09 100644 --- a/versioned_docs/version-2.12/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.12/reference/subsystems/autoflake.mdx index 8b8863dc7..1fcadfe46 100644 --- a/versioned_docs/version-2.12/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/bandit.mdx b/versioned_docs/version-2.12/reference/subsystems/bandit.mdx index 81f7a537c..b12bd8ed6 100644 --- a/versioned_docs/version-2.12/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/black.mdx b/versioned_docs/version-2.12/reference/subsystems/black.mdx index 2669514f5..04df305ee 100644 --- a/versioned_docs/version-2.12/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/buf.mdx b/versioned_docs/version-2.12/reference/subsystems/buf.mdx index 3935ef252..e2b7b58b7 100644 --- a/versioned_docs/version-2.12/reference/subsystems/buf.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/changed.mdx b/versioned_docs/version-2.12/reference/subsystems/changed.mdx index 4807a305b..7a0b9342c 100644 --- a/versioned_docs/version-2.12/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/cli.mdx b/versioned_docs/version-2.12/reference/subsystems/cli.mdx index c0442a850..8360e3d72 100644 --- a/versioned_docs/version-2.12/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/coursier.mdx b/versioned_docs/version-2.12/reference/subsystems/coursier.mdx index 6fd0966ea..2b80e51a3 100644 --- a/versioned_docs/version-2.12/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. (https://get-coursier.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.12/reference/subsystems/coverage-py.mdx index 9047886f7..d91bf8caa 100644 --- a/versioned_docs/version-2.12/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.12/reference/subsystems/docformatter.mdx index 892115209..963386f20 100644 --- a/versioned_docs/version-2.12/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/docker.mdx b/versioned_docs/version-2.12/reference/subsystems/docker.mdx index 5a0de60bb..c94a8d3b8 100644 --- a/versioned_docs/version-2.12/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.12/reference/subsystems/dockerfile-parser.mdx index 27977f5fa..0a5cfc7dd 100644 --- a/versioned_docs/version-2.12/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/download-terraform.mdx b/versioned_docs/version-2.12/reference/subsystems/download-terraform.mdx index c59bc8d21..c4163f894 100644 --- a/versioned_docs/version-2.12/reference/subsystems/download-terraform.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/flake8.mdx b/versioned_docs/version-2.12/reference/subsystems/flake8.mdx index 250764e38..6296a0e2e 100644 --- a/versioned_docs/version-2.12/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/go-test.mdx b/versioned_docs/version-2.12/reference/subsystems/go-test.mdx index 9252a1705..5cabdcf16 100644 --- a/versioned_docs/version-2.12/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.12/reference/subsystems/gofmt.mdx index 48adb856b..ef6158352 100644 --- a/versioned_docs/version-2.12/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/golang.mdx b/versioned_docs/version-2.12/reference/subsystems/golang.mdx index 9f0765174..24e35dc7d 100644 --- a/versioned_docs/version-2.12/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.12/reference/subsystems/google-java-format.mdx index abed8faed..3b92c0bb5 100644 --- a/versioned_docs/version-2.12/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.12/reference/subsystems/grpc-python-plugin.mdx index ea90ccbdf..427a14fc8 100644 --- a/versioned_docs/version-2.12/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.12/reference/subsystems/hadolint.mdx index 8fcd10dc7..d8b482f5a 100644 --- a/versioned_docs/version-2.12/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/helm-unittest.mdx b/versioned_docs/version-2.12/reference/subsystems/helm-unittest.mdx index 86e82ddaf..bd8027193 100644 --- a/versioned_docs/version-2.12/reference/subsystems/helm-unittest.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/helm-unittest.mdx @@ -1,5 +1,7 @@ --- title: helm-unittest +description: | + BDD styled unit test framework for Kubernetes Helm charts as a Helm plugin. (https://github.com/quintush/helm-unittest) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/helm.mdx b/versioned_docs/version-2.12/reference/subsystems/helm.mdx index 22e40dc12..3d99d58bb 100644 --- a/versioned_docs/version-2.12/reference/subsystems/helm.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/ipython.mdx b/versioned_docs/version-2.12/reference/subsystems/ipython.mdx index e2b30a9f2..00e315ab6 100644 --- a/versioned_docs/version-2.12/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/isort.mdx b/versioned_docs/version-2.12/reference/subsystems/isort.mdx index f03a269ad..9274d51f8 100644 --- a/versioned_docs/version-2.12/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.12/reference/subsystems/java-infer.mdx index 07ad97d71..32288f04c 100644 --- a/versioned_docs/version-2.12/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/javac.mdx b/versioned_docs/version-2.12/reference/subsystems/javac.mdx index 39c0a356c..742979cf0 100644 --- a/versioned_docs/version-2.12/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/junit.mdx b/versioned_docs/version-2.12/reference/subsystems/junit.mdx index f9d4ae53f..5382b673c 100644 --- a/versioned_docs/version-2.12/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/jvm.mdx b/versioned_docs/version-2.12/reference/subsystems/jvm.mdx index 6bd2e0b64..d91ba6a62 100644 --- a/versioned_docs/version-2.12/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/kotlin-infer.mdx b/versioned_docs/version-2.12/reference/subsystems/kotlin-infer.mdx index 1241c712c..89eb838c9 100644 --- a/versioned_docs/version-2.12/reference/subsystems/kotlin-infer.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/kotlin-infer.mdx @@ -1,5 +1,7 @@ --- title: kotlin-infer +description: | + Options controlling which dependencies will be inferred for Kotlin targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/kotlin.mdx b/versioned_docs/version-2.12/reference/subsystems/kotlin.mdx index 2498ccfb3..5435fd6d5 100644 --- a/versioned_docs/version-2.12/reference/subsystems/kotlin.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/kotlin.mdx @@ -1,5 +1,7 @@ --- title: kotlin +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/kotlinc.mdx b/versioned_docs/version-2.12/reference/subsystems/kotlinc.mdx index 428423319..3c9d68d40 100644 --- a/versioned_docs/version-2.12/reference/subsystems/kotlinc.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/kotlinc.mdx @@ -1,5 +1,7 @@ --- title: kotlinc +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.12/reference/subsystems/ktlint.mdx index ca066e77c..fb9b58c3f 100644 --- a/versioned_docs/version-2.12/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/ktlint.mdx @@ -1,5 +1,7 @@ --- title: ktlint +description: | + Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.12/reference/subsystems/lambdex.mdx index fc8345089..2a6b6dae8 100644 --- a/versioned_docs/version-2.12/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.12/reference/subsystems/mypy-protobuf.mdx index 48318b181..a8b85f02e 100644 --- a/versioned_docs/version-2.12/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/mypy.mdx b/versioned_docs/version-2.12/reference/subsystems/mypy.mdx index bf0ffad4b..f86d14b63 100644 --- a/versioned_docs/version-2.12/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.12/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.12/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.12/reference/subsystems/pex-cli.mdx index baf47bc5b..9bfc0c49d 100644 --- a/versioned_docs/version-2.12/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/pex.mdx b/versioned_docs/version-2.12/reference/subsystems/pex.mdx index f908d512e..43cbd3007 100644 --- a/versioned_docs/version-2.12/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/poetry.mdx b/versioned_docs/version-2.12/reference/subsystems/poetry.mdx index cdb2ff28b..e1fb1046d 100644 --- a/versioned_docs/version-2.12/reference/subsystems/poetry.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/poetry.mdx @@ -1,5 +1,7 @@ --- title: poetry +description: | + Used to generate lockfiles for third-party Python dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/protoc.mdx b/versioned_docs/version-2.12/reference/subsystems/protoc.mdx index 804dec0d2..e2f9074ca 100644 --- a/versioned_docs/version-2.12/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/pylint.mdx b/versioned_docs/version-2.12/reference/subsystems/pylint.mdx index e8aa469c8..cbfb30f24 100644 --- a/versioned_docs/version-2.12/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.12/reference/subsystems/pyoxidizer.mdx index 3b618d760..c36c3ca7a 100644 --- a/versioned_docs/version-2.12/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/pytest.mdx b/versioned_docs/version-2.12/reference/subsystems/pytest.mdx index 0bf2c4af3..3061a5b28 100644 --- a/versioned_docs/version-2.12/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.12/reference/subsystems/python-bootstrap.mdx index 185479e81..3a75fa3bb 100644 --- a/versioned_docs/version-2.12/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters used by all Pants backends. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.12/reference/subsystems/python-infer.mdx index 84cf922df..ecbaf5e14 100644 --- a/versioned_docs/version-2.12/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.12/reference/subsystems/python-native-code.mdx index b20614544..5fd95d1c8 100644 --- a/versioned_docs/version-2.12/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.12/reference/subsystems/python-protobuf.mdx index a73654c17..1af16c104 100644 --- a/versioned_docs/version-2.12/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.12/reference/subsystems/python-repos.mdx index 3d1fc03c6..665b4342b 100644 --- a/versioned_docs/version-2.12/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.12/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/versioned_docs/version-2.12/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/python.mdx b/versioned_docs/version-2.12/reference/subsystems/python.mdx index 63f8180d3..d935d5933 100644 --- a/versioned_docs/version-2.12/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.12/reference/subsystems/pyupgrade.mdx index 2f8e4e772..b8bb6fe13 100644 --- a/versioned_docs/version-2.12/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.12/reference/subsystems/regex-lint.mdx index db61aaef2..aed48bbdc 100644 --- a/versioned_docs/version-2.12/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.12/reference/subsystems/scala-infer.mdx index 6d5bf38d9..fcdec1f1d 100644 --- a/versioned_docs/version-2.12/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/scala.mdx b/versioned_docs/version-2.12/reference/subsystems/scala.mdx index 78056aca5..5d6628858 100644 --- a/versioned_docs/version-2.12/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/scalac.mdx b/versioned_docs/version-2.12/reference/subsystems/scalac.mdx index 93dd5914c..d2ddec7ca 100644 --- a/versioned_docs/version-2.12/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.12/reference/subsystems/scalafmt.mdx index 7b51cfb10..28f31dcaf 100644 --- a/versioned_docs/version-2.12/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.12/reference/subsystems/scalapb.mdx index b224f67a9..b3def3715 100644 --- a/versioned_docs/version-2.12/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.12/reference/subsystems/scalatest.mdx index 05d4bd080..476fa93b7 100644 --- a/versioned_docs/version-2.12/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/scc.mdx b/versioned_docs/version-2.12/reference/subsystems/scc.mdx index cb6fd424c..e87f99927 100644 --- a/versioned_docs/version-2.12/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.12/reference/subsystems/setup-py-generation.mdx index 1f5e97187..5f9ca632c 100644 --- a/versioned_docs/version-2.12/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.12/reference/subsystems/setuptools.mdx index a60451488..38f3bd707 100644 --- a/versioned_docs/version-2.12/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.12/reference/subsystems/shell-setup.mdx index 2bf26331b..5e0755245 100644 --- a/versioned_docs/version-2.12/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.12/reference/subsystems/shellcheck.mdx index 30dbaccfb..ab1b1f306 100644 --- a/versioned_docs/version-2.12/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.12/reference/subsystems/shfmt.mdx index bc8d93a2e..d137f754b 100644 --- a/versioned_docs/version-2.12/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/source.mdx b/versioned_docs/version-2.12/reference/subsystems/source.mdx index e9699c2da..611f7891e 100644 --- a/versioned_docs/version-2.12/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/stats.mdx b/versioned_docs/version-2.12/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.12/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.12/reference/subsystems/subprocess-environment.mdx index 996057ea4..b16cf47f8 100644 --- a/versioned_docs/version-2.12/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/terraform-fmt.mdx b/versioned_docs/version-2.12/reference/subsystems/terraform-fmt.mdx index 70511ac58..500597b9e 100644 --- a/versioned_docs/version-2.12/reference/subsystems/terraform-fmt.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/terraform-hcl2-parser.mdx b/versioned_docs/version-2.12/reference/subsystems/terraform-hcl2-parser.mdx index 5257eb9e7..a93246ea5 100644 --- a/versioned_docs/version-2.12/reference/subsystems/terraform-hcl2-parser.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/terraform-validate.mdx b/versioned_docs/version-2.12/reference/subsystems/terraform-validate.mdx index befc5252a..544d2ad9b 100644 --- a/versioned_docs/version-2.12/reference/subsystems/terraform-validate.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/thrift.mdx b/versioned_docs/version-2.12/reference/subsystems/thrift.mdx index 53a481bec..abf3614f2 100644 --- a/versioned_docs/version-2.12/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/twine.mdx b/versioned_docs/version-2.12/reference/subsystems/twine.mdx index 7826e6baa..2056088b7 100644 --- a/versioned_docs/version-2.12/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPi and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/subsystems/yapf.mdx b/versioned_docs/version-2.12/reference/subsystems/yapf.mdx index 66963dd07..01644a3f5 100644 --- a/versioned_docs/version-2.12/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.12/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.12/reference/targets/archive.mdx b/versioned_docs/version-2.12/reference/targets/archive.mdx index 801685458..921bde6e0 100644 --- a/versioned_docs/version-2.12/reference/targets/archive.mdx +++ b/versioned_docs/version-2.12/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.12/reference/targets/deploy_jar.mdx index 0b9d3ae36..cec93fcae 100644 --- a/versioned_docs/version-2.12/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.12/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/docker_image.mdx b/versioned_docs/version-2.12/reference/targets/docker_image.mdx index 09104c98c..1a2cf1ccc 100644 --- a/versioned_docs/version-2.12/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.12/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/experimental_run_shell_command.mdx b/versioned_docs/version-2.12/reference/targets/experimental_run_shell_command.mdx index 1f0a43fea..0d68bfa6e 100644 --- a/versioned_docs/version-2.12/reference/targets/experimental_run_shell_command.mdx +++ b/versioned_docs/version-2.12/reference/targets/experimental_run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/experimental_shell_command.mdx b/versioned_docs/version-2.12/reference/targets/experimental_shell_command.mdx index 5f8a608fe..8b2702a0c 100644 --- a/versioned_docs/version-2.12/reference/targets/experimental_shell_command.mdx +++ b/versioned_docs/version-2.12/reference/targets/experimental_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/file.mdx b/versioned_docs/version-2.12/reference/targets/file.mdx index 5ec078d49..10cf0d8c4 100644 --- a/versioned_docs/version-2.12/reference/targets/file.mdx +++ b/versioned_docs/version-2.12/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/files.mdx b/versioned_docs/version-2.12/reference/targets/files.mdx index 8a72dd869..b9551667b 100644 --- a/versioned_docs/version-2.12/reference/targets/files.mdx +++ b/versioned_docs/version-2.12/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/go_binary.mdx b/versioned_docs/version-2.12/reference/targets/go_binary.mdx index 26351b1ff..9b710af9a 100644 --- a/versioned_docs/version-2.12/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.12/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/go_mod.mdx b/versioned_docs/version-2.12/reference/targets/go_mod.mdx index caeac0e75..0ab3a00d5 100644 --- a/versioned_docs/version-2.12/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.12/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/go_package.mdx b/versioned_docs/version-2.12/reference/targets/go_package.mdx index 2af5b9b4e..892c46480 100644 --- a/versioned_docs/version-2.12/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.12/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.12/reference/targets/go_third_party_package.mdx index 449c60662..d849765b8 100644 --- a/versioned_docs/version-2.12/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.12/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/helm_artifact.mdx b/versioned_docs/version-2.12/reference/targets/helm_artifact.mdx index 33546af67..1fe4aeb34 100644 --- a/versioned_docs/version-2.12/reference/targets/helm_artifact.mdx +++ b/versioned_docs/version-2.12/reference/targets/helm_artifact.mdx @@ -1,5 +1,7 @@ --- title: helm_artifact +description: | + A third party Helm artifact. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/helm_chart.mdx b/versioned_docs/version-2.12/reference/targets/helm_chart.mdx index a7b9c38fd..34b9b1573 100644 --- a/versioned_docs/version-2.12/reference/targets/helm_chart.mdx +++ b/versioned_docs/version-2.12/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/helm_unittest_test.mdx b/versioned_docs/version-2.12/reference/targets/helm_unittest_test.mdx index 71e19e790..a667b9a17 100644 --- a/versioned_docs/version-2.12/reference/targets/helm_unittest_test.mdx +++ b/versioned_docs/version-2.12/reference/targets/helm_unittest_test.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_test +description: | + A single helm-unittest suite file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/helm_unittest_tests.mdx b/versioned_docs/version-2.12/reference/targets/helm_unittest_tests.mdx index 93bbc0d3d..6a50cc052 100644 --- a/versioned_docs/version-2.12/reference/targets/helm_unittest_tests.mdx +++ b/versioned_docs/version-2.12/reference/targets/helm_unittest_tests.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_tests +description: | + Generates a `helm_unittest_test` target per each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/java_source.mdx b/versioned_docs/version-2.12/reference/targets/java_source.mdx index 2ae5c1798..e2dcdb2bc 100644 --- a/versioned_docs/version-2.12/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.12/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/java_sources.mdx b/versioned_docs/version-2.12/reference/targets/java_sources.mdx index 105d565d8..f529d45d5 100644 --- a/versioned_docs/version-2.12/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.12/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/junit_test.mdx b/versioned_docs/version-2.12/reference/targets/junit_test.mdx index 351f3a438..72b0da83d 100644 --- a/versioned_docs/version-2.12/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.12/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/junit_tests.mdx b/versioned_docs/version-2.12/reference/targets/junit_tests.mdx index c486d9b2c..5ff773cac 100644 --- a/versioned_docs/version-2.12/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.12/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.12/reference/targets/jvm_artifact.mdx index 57c626586..c68e45b77 100644 --- a/versioned_docs/version-2.12/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.12/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/jvm_war.mdx b/versioned_docs/version-2.12/reference/targets/jvm_war.mdx index 86d63d31d..b13a30b8a 100644 --- a/versioned_docs/version-2.12/reference/targets/jvm_war.mdx +++ b/versioned_docs/version-2.12/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/kotlin_source.mdx b/versioned_docs/version-2.12/reference/targets/kotlin_source.mdx index 65088bdae..883a77752 100644 --- a/versioned_docs/version-2.12/reference/targets/kotlin_source.mdx +++ b/versioned_docs/version-2.12/reference/targets/kotlin_source.mdx @@ -1,5 +1,7 @@ --- title: kotlin_source +description: | + A single Kotlin source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/kotlin_sources.mdx b/versioned_docs/version-2.12/reference/targets/kotlin_sources.mdx index 1eceb6d79..f9fd5d2a9 100644 --- a/versioned_docs/version-2.12/reference/targets/kotlin_sources.mdx +++ b/versioned_docs/version-2.12/reference/targets/kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: kotlin_sources +description: | + Generate a `kotlin_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/kotlinc_plugin.mdx b/versioned_docs/version-2.12/reference/targets/kotlinc_plugin.mdx index 5facbbddf..d852ce371 100644 --- a/versioned_docs/version-2.12/reference/targets/kotlinc_plugin.mdx +++ b/versioned_docs/version-2.12/reference/targets/kotlinc_plugin.mdx @@ -1,5 +1,7 @@ --- title: kotlinc_plugin +description: | + A plugin for `kotlinc`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.12/reference/targets/pants_requirements.mdx index 486c52006..5f77df4d7 100644 --- a/versioned_docs/version-2.12/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.12/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.12/reference/targets/pex_binaries.mdx index 6827cf08f..5adf9fa03 100644 --- a/versioned_docs/version-2.12/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.12/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/pex_binary.mdx b/versioned_docs/version-2.12/reference/targets/pex_binary.mdx index 47013de29..c437e59bc 100644 --- a/versioned_docs/version-2.12/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.12/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.12/reference/targets/pipenv_requirements.mdx index 1a319f31a..456d214f0 100644 --- a/versioned_docs/version-2.12/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.12/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.12/reference/targets/poetry_requirements.mdx index 344c86b2f..eed2cdde4 100644 --- a/versioned_docs/version-2.12/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.12/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry pyproject.toml. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.12/reference/targets/protobuf_source.mdx index 6e6a0e673..eda4c280f 100644 --- a/versioned_docs/version-2.12/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.12/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.12/reference/targets/protobuf_sources.mdx index 4b448fd9a..e680caef8 100644 --- a/versioned_docs/version-2.12/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.12/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.12/reference/targets/pyoxidizer_binary.mdx index e7e8b10c2..7a7da5f99 100644 --- a/versioned_docs/version-2.12/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.12/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.12/reference/targets/python_awslambda.mdx index 36df4c59a..291e4d7b7 100644 --- a/versioned_docs/version-2.12/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_distribution.mdx b/versioned_docs/version-2.12/reference/targets/python_distribution.mdx index 23dbe75ce..b138ebdbc 100644 --- a/versioned_docs/version-2.12/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.12/reference/targets/python_google_cloud_function.mdx index 8dc79bad5..ba44aafc4 100644 --- a/versioned_docs/version-2.12/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_requirement.mdx b/versioned_docs/version-2.12/reference/targets/python_requirement.mdx index 8ce8a552a..3a7f4588d 100644 --- a/versioned_docs/version-2.12/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_requirements.mdx b/versioned_docs/version-2.12/reference/targets/python_requirements.mdx index 6fba0b9aa..0d6ee928b 100644 --- a/versioned_docs/version-2.12/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style file from the `source` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_source.mdx b/versioned_docs/version-2.12/reference/targets/python_source.mdx index 4be4c0f2b..ea91af2da 100644 --- a/versioned_docs/version-2.12/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_sources.mdx b/versioned_docs/version-2.12/reference/targets/python_sources.mdx index a3d53dfba..96aa8800d 100644 --- a/versioned_docs/version-2.12/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_test.mdx b/versioned_docs/version-2.12/reference/targets/python_test.mdx index 31b967a81..8bbde1fea 100644 --- a/versioned_docs/version-2.12/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.12/reference/targets/python_test_utils.mdx index f1fd7ff27..0ce8a3238 100644 --- a/versioned_docs/version-2.12/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/python_tests.mdx b/versioned_docs/version-2.12/reference/targets/python_tests.mdx index a14d40baa..64d8ede77 100644 --- a/versioned_docs/version-2.12/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.12/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/relocated_files.mdx b/versioned_docs/version-2.12/reference/targets/relocated_files.mdx index b920f40cd..27951f1bf 100644 --- a/versioned_docs/version-2.12/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.12/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/resource.mdx b/versioned_docs/version-2.12/reference/targets/resource.mdx index 02758c417..e79fcb6ca 100644 --- a/versioned_docs/version-2.12/reference/targets/resource.mdx +++ b/versioned_docs/version-2.12/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/resources.mdx b/versioned_docs/version-2.12/reference/targets/resources.mdx index 1ad5aa6c8..c63b6fa9d 100644 --- a/versioned_docs/version-2.12/reference/targets/resources.mdx +++ b/versioned_docs/version-2.12/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.12/reference/targets/scala_junit_test.mdx index 2c8dfe272..26da6fe04 100644 --- a/versioned_docs/version-2.12/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.12/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.12/reference/targets/scala_junit_tests.mdx index 01d9da13c..e4252a0ad 100644 --- a/versioned_docs/version-2.12/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.12/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/scala_source.mdx b/versioned_docs/version-2.12/reference/targets/scala_source.mdx index c4d84b636..6b3311dd3 100644 --- a/versioned_docs/version-2.12/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.12/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/scala_sources.mdx b/versioned_docs/version-2.12/reference/targets/scala_sources.mdx index 390af530e..8ec839726 100644 --- a/versioned_docs/version-2.12/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.12/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.12/reference/targets/scalac_plugin.mdx index 2d5fa0e60..8253ded67 100644 --- a/versioned_docs/version-2.12/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.12/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.12/reference/targets/scalatest_test.mdx index 7d8d793bb..2399cf0ec 100644 --- a/versioned_docs/version-2.12/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.12/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.12/reference/targets/scalatest_tests.mdx index cc16fff85..b740b98f2 100644 --- a/versioned_docs/version-2.12/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.12/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching ('*Spec.scala', '*Suite.scala')). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/shell_source.mdx b/versioned_docs/version-2.12/reference/targets/shell_source.mdx index 0f6d14c3a..4b8e6a2be 100644 --- a/versioned_docs/version-2.12/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.12/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/shell_sources.mdx b/versioned_docs/version-2.12/reference/targets/shell_sources.mdx index 26dd00b37..194bab340 100644 --- a/versioned_docs/version-2.12/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.12/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.12/reference/targets/shunit2_test.mdx index 22c2e3615..f001f75ed 100644 --- a/versioned_docs/version-2.12/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.12/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.12/reference/targets/shunit2_tests.mdx index e00aac8f5..78e5189a1 100644 --- a/versioned_docs/version-2.12/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.12/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/target.mdx b/versioned_docs/version-2.12/reference/targets/target.mdx index aba6af9e3..4be9000f4 100644 --- a/versioned_docs/version-2.12/reference/targets/target.mdx +++ b/versioned_docs/version-2.12/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/terraform_module.mdx b/versioned_docs/version-2.12/reference/targets/terraform_module.mdx index 26f8f2a47..4787d47a7 100644 --- a/versioned_docs/version-2.12/reference/targets/terraform_module.mdx +++ b/versioned_docs/version-2.12/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/thrift_source.mdx b/versioned_docs/version-2.12/reference/targets/thrift_source.mdx index 12753d0ab..488f3648e 100644 --- a/versioned_docs/version-2.12/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.12/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.12/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.12/reference/targets/thrift_sources.mdx index 084509c09..e40edfa2d 100644 --- a/versioned_docs/version-2.12/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.12/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/global-options.mdx b/versioned_docs/version-2.13/reference/global-options.mdx index f96a173e9..5d94fd7af 100644 --- a/versioned_docs/version-2.13/reference/global-options.mdx +++ b/versioned_docs/version-2.13/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/check.mdx b/versioned_docs/version-2.13/reference/goals/check.mdx index 23a07a302..3e1e8fb96 100644 --- a/versioned_docs/version-2.13/reference/goals/check.mdx +++ b/versioned_docs/version-2.13/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/count-loc.mdx b/versioned_docs/version-2.13/reference/goals/count-loc.mdx index 1ba93875f..72569e225 100644 --- a/versioned_docs/version-2.13/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.13/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/dependees.mdx b/versioned_docs/version-2.13/reference/goals/dependees.mdx index 9fe453529..92df8e0da 100644 --- a/versioned_docs/version-2.13/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.13/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/dependencies.mdx b/versioned_docs/version-2.13/reference/goals/dependencies.mdx index afa627dcb..535e0d3e9 100644 --- a/versioned_docs/version-2.13/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.13/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.13/reference/goals/experimental-bsp.mdx index 43b3b3123..8747d33cb 100644 --- a/versioned_docs/version-2.13/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.13/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/experimental-explorer.mdx b/versioned_docs/version-2.13/reference/goals/experimental-explorer.mdx index eb5e42352..7df90e7dc 100644 --- a/versioned_docs/version-2.13/reference/goals/experimental-explorer.mdx +++ b/versioned_docs/version-2.13/reference/goals/experimental-explorer.mdx @@ -1,5 +1,7 @@ --- title: experimental-explorer +description: | + Run the Pants Explorer Web UI server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/export-codegen.mdx b/versioned_docs/version-2.13/reference/goals/export-codegen.mdx index 480457e00..41f9cb335 100644 --- a/versioned_docs/version-2.13/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.13/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/export.mdx b/versioned_docs/version-2.13/reference/goals/export.mdx index 7f9c9a768..233f8fc10 100644 --- a/versioned_docs/version-2.13/reference/goals/export.mdx +++ b/versioned_docs/version-2.13/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/filedeps.mdx b/versioned_docs/version-2.13/reference/goals/filedeps.mdx index c2820b136..597601d62 100644 --- a/versioned_docs/version-2.13/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.13/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/filter.mdx b/versioned_docs/version-2.13/reference/goals/filter.mdx index 57caac539..8183d3a15 100644 --- a/versioned_docs/version-2.13/reference/goals/filter.mdx +++ b/versioned_docs/version-2.13/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/fmt.mdx b/versioned_docs/version-2.13/reference/goals/fmt.mdx index ed787cbd0..c79facb06 100644 --- a/versioned_docs/version-2.13/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.13/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.13/reference/goals/generate-lockfiles.mdx index 4b9e3e4ea..8d4b691bd 100644 --- a/versioned_docs/version-2.13/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.13/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for Python third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/help-advanced.mdx b/versioned_docs/version-2.13/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.13/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.13/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/help-all.mdx b/versioned_docs/version-2.13/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.13/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.13/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/help.mdx b/versioned_docs/version-2.13/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.13/reference/goals/help.mdx +++ b/versioned_docs/version-2.13/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/lint.mdx b/versioned_docs/version-2.13/reference/goals/lint.mdx index 456990645..1194e1633 100644 --- a/versioned_docs/version-2.13/reference/goals/lint.mdx +++ b/versioned_docs/version-2.13/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/list.mdx b/versioned_docs/version-2.13/reference/goals/list.mdx index 81f09ad04..7e2a5bc34 100644 --- a/versioned_docs/version-2.13/reference/goals/list.mdx +++ b/versioned_docs/version-2.13/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/package.mdx b/versioned_docs/version-2.13/reference/goals/package.mdx index f6dd89058..55ca2eaa7 100644 --- a/versioned_docs/version-2.13/reference/goals/package.mdx +++ b/versioned_docs/version-2.13/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/paths.mdx b/versioned_docs/version-2.13/reference/goals/paths.mdx index e02310a99..7dd9a6c02 100644 --- a/versioned_docs/version-2.13/reference/goals/paths.mdx +++ b/versioned_docs/version-2.13/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/peek.mdx b/versioned_docs/version-2.13/reference/goals/peek.mdx index cdacc6bfb..ff4b4feec 100644 --- a/versioned_docs/version-2.13/reference/goals/peek.mdx +++ b/versioned_docs/version-2.13/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/publish.mdx b/versioned_docs/version-2.13/reference/goals/publish.mdx index fa4093d9c..4628c5df2 100644 --- a/versioned_docs/version-2.13/reference/goals/publish.mdx +++ b/versioned_docs/version-2.13/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/py-constraints.mdx b/versioned_docs/version-2.13/reference/goals/py-constraints.mdx index 962bb569f..4d857d849 100644 --- a/versioned_docs/version-2.13/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.13/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/repl.mdx b/versioned_docs/version-2.13/reference/goals/repl.mdx index 30b83cad3..e7d6b9bfa 100644 --- a/versioned_docs/version-2.13/reference/goals/repl.mdx +++ b/versioned_docs/version-2.13/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/roots.mdx b/versioned_docs/version-2.13/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.13/reference/goals/roots.mdx +++ b/versioned_docs/version-2.13/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/run.mdx b/versioned_docs/version-2.13/reference/goals/run.mdx index a814ca58a..084146e60 100644 --- a/versioned_docs/version-2.13/reference/goals/run.mdx +++ b/versioned_docs/version-2.13/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/tailor.mdx b/versioned_docs/version-2.13/reference/goals/tailor.mdx index ed6693a8d..784b6097c 100644 --- a/versioned_docs/version-2.13/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.13/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/test.mdx b/versioned_docs/version-2.13/reference/goals/test.mdx index dd72c7150..dbf683c18 100644 --- a/versioned_docs/version-2.13/reference/goals/test.mdx +++ b/versioned_docs/version-2.13/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/update-build-files.mdx b/versioned_docs/version-2.13/reference/goals/update-build-files.mdx index 9e64255ef..cfe41a7f6 100644 --- a/versioned_docs/version-2.13/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.13/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/goals/version.mdx b/versioned_docs/version-2.13/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.13/reference/goals/version.mdx +++ b/versioned_docs/version-2.13/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.13/reference/subsystems/anonymous-telemetry.mdx index c295a0c3f..2f12c6683 100644 --- a/versioned_docs/version-2.13/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.13/reference/subsystems/apache-thrift.mdx index 32fe0a891..2b9ce0a09 100644 --- a/versioned_docs/version-2.13/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.13/reference/subsystems/autoflake.mdx index 2f86f5708..f01f44f95 100644 --- a/versioned_docs/version-2.13/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/bandit.mdx b/versioned_docs/version-2.13/reference/subsystems/bandit.mdx index 49b1cb1c6..afaed8dac 100644 --- a/versioned_docs/version-2.13/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/black.mdx b/versioned_docs/version-2.13/reference/subsystems/black.mdx index c616dd2de..3f59d6d03 100644 --- a/versioned_docs/version-2.13/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/buf.mdx b/versioned_docs/version-2.13/reference/subsystems/buf.mdx index 0287b1130..2ce81758e 100644 --- a/versioned_docs/version-2.13/reference/subsystems/buf.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/changed.mdx b/versioned_docs/version-2.13/reference/subsystems/changed.mdx index 76c63428d..db1f79f57 100644 --- a/versioned_docs/version-2.13/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/cli.mdx b/versioned_docs/version-2.13/reference/subsystems/cli.mdx index c0442a850..8360e3d72 100644 --- a/versioned_docs/version-2.13/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/coursier.mdx b/versioned_docs/version-2.13/reference/subsystems/coursier.mdx index 6eb872db4..d4621b05b 100644 --- a/versioned_docs/version-2.13/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. (https://get-coursier.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.13/reference/subsystems/coverage-py.mdx index b1735adfd..bf67eefe7 100644 --- a/versioned_docs/version-2.13/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/debug-adapter.mdx b/versioned_docs/version-2.13/reference/subsystems/debug-adapter.mdx index d15f05658..655c51060 100644 --- a/versioned_docs/version-2.13/reference/subsystems/debug-adapter.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/debug-adapter.mdx @@ -1,5 +1,7 @@ --- title: debug-adapter +description: | + Options used to configure and launch a Debug Adapter server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/debugpy.mdx b/versioned_docs/version-2.13/reference/subsystems/debugpy.mdx index fcbb6dae1..8e1b7ee3b 100644 --- a/versioned_docs/version-2.13/reference/subsystems/debugpy.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/debugpy.mdx @@ -1,5 +1,7 @@ --- title: debugpy +description: | + An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.13/reference/subsystems/docformatter.mdx index 073f4533b..c6f9ccc41 100644 --- a/versioned_docs/version-2.13/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/docker.mdx b/versioned_docs/version-2.13/reference/subsystems/docker.mdx index 5495bedb1..284ae93bd 100644 --- a/versioned_docs/version-2.13/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.13/reference/subsystems/dockerfile-parser.mdx index a1c66d4e2..b245e2ccc 100644 --- a/versioned_docs/version-2.13/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/download-terraform.mdx b/versioned_docs/version-2.13/reference/subsystems/download-terraform.mdx index 477a5a4d7..00b07e439 100644 --- a/versioned_docs/version-2.13/reference/subsystems/download-terraform.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/flake8.mdx b/versioned_docs/version-2.13/reference/subsystems/flake8.mdx index faeaa150f..1e493788d 100644 --- a/versioned_docs/version-2.13/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/go-test.mdx b/versioned_docs/version-2.13/reference/subsystems/go-test.mdx index 9252a1705..5cabdcf16 100644 --- a/versioned_docs/version-2.13/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.13/reference/subsystems/gofmt.mdx index 48adb856b..ef6158352 100644 --- a/versioned_docs/version-2.13/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/golang.mdx b/versioned_docs/version-2.13/reference/subsystems/golang.mdx index 5fb0d26b9..c1ef58e65 100644 --- a/versioned_docs/version-2.13/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.13/reference/subsystems/google-java-format.mdx index 5f437fe65..44ba96230 100644 --- a/versioned_docs/version-2.13/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.13/reference/subsystems/grpc-python-plugin.mdx index 03cca43d8..f1fa0c693 100644 --- a/versioned_docs/version-2.13/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.13/reference/subsystems/hadolint.mdx index e7fa3a869..f22cab32a 100644 --- a/versioned_docs/version-2.13/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/helm-unittest.mdx b/versioned_docs/version-2.13/reference/subsystems/helm-unittest.mdx index 0e09fe8c5..4b62a44ed 100644 --- a/versioned_docs/version-2.13/reference/subsystems/helm-unittest.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/helm-unittest.mdx @@ -1,5 +1,7 @@ --- title: helm-unittest +description: | + BDD styled unit test framework for Kubernetes Helm charts as a Helm plugin. (https://github.com/quintush/helm-unittest) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/helm.mdx b/versioned_docs/version-2.13/reference/subsystems/helm.mdx index ed8d6f726..ce3e66bff 100644 --- a/versioned_docs/version-2.13/reference/subsystems/helm.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/ipython.mdx b/versioned_docs/version-2.13/reference/subsystems/ipython.mdx index 02e375735..cc4324353 100644 --- a/versioned_docs/version-2.13/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/isort.mdx b/versioned_docs/version-2.13/reference/subsystems/isort.mdx index a6515f42a..210b6b35b 100644 --- a/versioned_docs/version-2.13/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.13/reference/subsystems/java-infer.mdx index 9b365727f..2088e9ff2 100644 --- a/versioned_docs/version-2.13/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/javac.mdx b/versioned_docs/version-2.13/reference/subsystems/javac.mdx index 32f80db89..a7ac13086 100644 --- a/versioned_docs/version-2.13/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/junit.mdx b/versioned_docs/version-2.13/reference/subsystems/junit.mdx index 977f501b5..3e907189a 100644 --- a/versioned_docs/version-2.13/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/jvm.mdx b/versioned_docs/version-2.13/reference/subsystems/jvm.mdx index 6bd2e0b64..d91ba6a62 100644 --- a/versioned_docs/version-2.13/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/kotlin-infer.mdx b/versioned_docs/version-2.13/reference/subsystems/kotlin-infer.mdx index 1241c712c..89eb838c9 100644 --- a/versioned_docs/version-2.13/reference/subsystems/kotlin-infer.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/kotlin-infer.mdx @@ -1,5 +1,7 @@ --- title: kotlin-infer +description: | + Options controlling which dependencies will be inferred for Kotlin targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/kotlin.mdx b/versioned_docs/version-2.13/reference/subsystems/kotlin.mdx index 25b150315..50785c245 100644 --- a/versioned_docs/version-2.13/reference/subsystems/kotlin.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/kotlin.mdx @@ -1,5 +1,7 @@ --- title: kotlin +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/kotlinc.mdx b/versioned_docs/version-2.13/reference/subsystems/kotlinc.mdx index 428423319..3c9d68d40 100644 --- a/versioned_docs/version-2.13/reference/subsystems/kotlinc.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/kotlinc.mdx @@ -1,5 +1,7 @@ --- title: kotlinc +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.13/reference/subsystems/ktlint.mdx index 03ebf658a..74e0310df 100644 --- a/versioned_docs/version-2.13/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/ktlint.mdx @@ -1,5 +1,7 @@ --- title: ktlint +description: | + Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.13/reference/subsystems/lambdex.mdx index 563c0079d..e816a1728 100644 --- a/versioned_docs/version-2.13/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.13/reference/subsystems/mypy-protobuf.mdx index d05e4a698..06e5b3cc3 100644 --- a/versioned_docs/version-2.13/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/mypy.mdx b/versioned_docs/version-2.13/reference/subsystems/mypy.mdx index ed3a632c5..ed48ef337 100644 --- a/versioned_docs/version-2.13/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.13/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.13/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.13/reference/subsystems/pex-cli.mdx index 72eae2767..57345d1c1 100644 --- a/versioned_docs/version-2.13/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/pex.mdx b/versioned_docs/version-2.13/reference/subsystems/pex.mdx index f908d512e..43cbd3007 100644 --- a/versioned_docs/version-2.13/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/poetry.mdx b/versioned_docs/version-2.13/reference/subsystems/poetry.mdx index cdb2ff28b..e1fb1046d 100644 --- a/versioned_docs/version-2.13/reference/subsystems/poetry.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/poetry.mdx @@ -1,5 +1,7 @@ --- title: poetry +description: | + Used to generate lockfiles for third-party Python dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/protoc.mdx b/versioned_docs/version-2.13/reference/subsystems/protoc.mdx index 58e2d8b4d..69948c3ea 100644 --- a/versioned_docs/version-2.13/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/pylint.mdx b/versioned_docs/version-2.13/reference/subsystems/pylint.mdx index 2e7d3bb0d..8327e2356 100644 --- a/versioned_docs/version-2.13/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.13/reference/subsystems/pyoxidizer.mdx index 3b618d760..c36c3ca7a 100644 --- a/versioned_docs/version-2.13/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/pytest.mdx b/versioned_docs/version-2.13/reference/subsystems/pytest.mdx index 29ca728e3..37966cd15 100644 --- a/versioned_docs/version-2.13/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.13/reference/subsystems/python-bootstrap.mdx index 185479e81..3a75fa3bb 100644 --- a/versioned_docs/version-2.13/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters used by all Pants backends. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.13/reference/subsystems/python-infer.mdx index b27da152d..2e357aed6 100644 --- a/versioned_docs/version-2.13/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.13/reference/subsystems/python-native-code.mdx index b20614544..5fd95d1c8 100644 --- a/versioned_docs/version-2.13/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.13/reference/subsystems/python-protobuf.mdx index b19c0c960..9bbbe2781 100644 --- a/versioned_docs/version-2.13/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.13/reference/subsystems/python-repos.mdx index 3d1fc03c6..665b4342b 100644 --- a/versioned_docs/version-2.13/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.13/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/versioned_docs/version-2.13/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/python.mdx b/versioned_docs/version-2.13/reference/subsystems/python.mdx index ac4aef445..809f3a23d 100644 --- a/versioned_docs/version-2.13/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.13/reference/subsystems/pyupgrade.mdx index 4d4384be5..bd17387e8 100644 --- a/versioned_docs/version-2.13/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.13/reference/subsystems/regex-lint.mdx index f4d161d67..bf470d95c 100644 --- a/versioned_docs/version-2.13/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.13/reference/subsystems/scala-infer.mdx index 07af52516..48f8e053d 100644 --- a/versioned_docs/version-2.13/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/scala.mdx b/versioned_docs/version-2.13/reference/subsystems/scala.mdx index b55c6b2ae..8184f5acf 100644 --- a/versioned_docs/version-2.13/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/scalac.mdx b/versioned_docs/version-2.13/reference/subsystems/scalac.mdx index 93dd5914c..d2ddec7ca 100644 --- a/versioned_docs/version-2.13/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.13/reference/subsystems/scalafmt.mdx index bf991c0e6..9c2b2b9cc 100644 --- a/versioned_docs/version-2.13/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.13/reference/subsystems/scalapb.mdx index 12a231451..1d4c24e10 100644 --- a/versioned_docs/version-2.13/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.13/reference/subsystems/scalatest.mdx index f3c6211fa..59674ded6 100644 --- a/versioned_docs/version-2.13/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/scc.mdx b/versioned_docs/version-2.13/reference/subsystems/scc.mdx index 2fb88fdfa..5ca455ad7 100644 --- a/versioned_docs/version-2.13/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.13/reference/subsystems/setup-py-generation.mdx index 1f5e97187..5f9ca632c 100644 --- a/versioned_docs/version-2.13/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/setuptools-scm.mdx b/versioned_docs/version-2.13/reference/subsystems/setuptools-scm.mdx index b5f27f017..306455539 100644 --- a/versioned_docs/version-2.13/reference/subsystems/setuptools-scm.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/setuptools-scm.mdx @@ -1,5 +1,7 @@ --- title: setuptools-scm +description: | + A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.13/reference/subsystems/setuptools.mdx index cbc9a9dc5..16b992683 100644 --- a/versioned_docs/version-2.13/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.13/reference/subsystems/shell-setup.mdx index 6b1142ab5..4c9c400d3 100644 --- a/versioned_docs/version-2.13/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.13/reference/subsystems/shellcheck.mdx index 07443a13a..122d67ece 100644 --- a/versioned_docs/version-2.13/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.13/reference/subsystems/shfmt.mdx index f5a9ede4d..d24696af7 100644 --- a/versioned_docs/version-2.13/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/source.mdx b/versioned_docs/version-2.13/reference/subsystems/source.mdx index c611ea221..25b04f740 100644 --- a/versioned_docs/version-2.13/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/stats.mdx b/versioned_docs/version-2.13/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.13/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.13/reference/subsystems/subprocess-environment.mdx index 0f73e412b..0ed1ccf4c 100644 --- a/versioned_docs/version-2.13/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/terraform-fmt.mdx b/versioned_docs/version-2.13/reference/subsystems/terraform-fmt.mdx index 70511ac58..500597b9e 100644 --- a/versioned_docs/version-2.13/reference/subsystems/terraform-fmt.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/terraform-hcl2-parser.mdx b/versioned_docs/version-2.13/reference/subsystems/terraform-hcl2-parser.mdx index d841ac1b7..523bdf666 100644 --- a/versioned_docs/version-2.13/reference/subsystems/terraform-hcl2-parser.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/terraform-validate.mdx b/versioned_docs/version-2.13/reference/subsystems/terraform-validate.mdx index befc5252a..544d2ad9b 100644 --- a/versioned_docs/version-2.13/reference/subsystems/terraform-validate.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/thrift.mdx b/versioned_docs/version-2.13/reference/subsystems/thrift.mdx index 230854701..7a691f82d 100644 --- a/versioned_docs/version-2.13/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/twine.mdx b/versioned_docs/version-2.13/reference/subsystems/twine.mdx index 60b986b00..567ea07ec 100644 --- a/versioned_docs/version-2.13/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPI and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/subsystems/yapf.mdx b/versioned_docs/version-2.13/reference/subsystems/yapf.mdx index 78a6f08bd..8ff9e9b13 100644 --- a/versioned_docs/version-2.13/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.13/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.13/reference/targets/archive.mdx b/versioned_docs/version-2.13/reference/targets/archive.mdx index 801685458..921bde6e0 100644 --- a/versioned_docs/version-2.13/reference/targets/archive.mdx +++ b/versioned_docs/version-2.13/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.13/reference/targets/deploy_jar.mdx index eb76ab9fd..bb011af8a 100644 --- a/versioned_docs/version-2.13/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.13/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/docker_image.mdx b/versioned_docs/version-2.13/reference/targets/docker_image.mdx index 4e5720af9..184fcd204 100644 --- a/versioned_docs/version-2.13/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.13/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/experimental_run_shell_command.mdx b/versioned_docs/version-2.13/reference/targets/experimental_run_shell_command.mdx index 3e572a380..c5e1108b5 100644 --- a/versioned_docs/version-2.13/reference/targets/experimental_run_shell_command.mdx +++ b/versioned_docs/version-2.13/reference/targets/experimental_run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/experimental_shell_command.mdx b/versioned_docs/version-2.13/reference/targets/experimental_shell_command.mdx index 84765a90a..4100bfa25 100644 --- a/versioned_docs/version-2.13/reference/targets/experimental_shell_command.mdx +++ b/versioned_docs/version-2.13/reference/targets/experimental_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/file.mdx b/versioned_docs/version-2.13/reference/targets/file.mdx index 63b74bf52..d9580c1ce 100644 --- a/versioned_docs/version-2.13/reference/targets/file.mdx +++ b/versioned_docs/version-2.13/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/files.mdx b/versioned_docs/version-2.13/reference/targets/files.mdx index aba528dd8..69a72e6b5 100644 --- a/versioned_docs/version-2.13/reference/targets/files.mdx +++ b/versioned_docs/version-2.13/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/go_binary.mdx b/versioned_docs/version-2.13/reference/targets/go_binary.mdx index 26351b1ff..9b710af9a 100644 --- a/versioned_docs/version-2.13/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.13/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/go_mod.mdx b/versioned_docs/version-2.13/reference/targets/go_mod.mdx index caeac0e75..0ab3a00d5 100644 --- a/versioned_docs/version-2.13/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.13/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/go_package.mdx b/versioned_docs/version-2.13/reference/targets/go_package.mdx index 2b4539611..26c459dd8 100644 --- a/versioned_docs/version-2.13/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.13/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.13/reference/targets/go_third_party_package.mdx index 96afb6488..da0306336 100644 --- a/versioned_docs/version-2.13/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.13/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/helm_artifact.mdx b/versioned_docs/version-2.13/reference/targets/helm_artifact.mdx index 33546af67..1fe4aeb34 100644 --- a/versioned_docs/version-2.13/reference/targets/helm_artifact.mdx +++ b/versioned_docs/version-2.13/reference/targets/helm_artifact.mdx @@ -1,5 +1,7 @@ --- title: helm_artifact +description: | + A third party Helm artifact. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/helm_chart.mdx b/versioned_docs/version-2.13/reference/targets/helm_chart.mdx index 11fc4d080..462579b29 100644 --- a/versioned_docs/version-2.13/reference/targets/helm_chart.mdx +++ b/versioned_docs/version-2.13/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/helm_unittest_test.mdx b/versioned_docs/version-2.13/reference/targets/helm_unittest_test.mdx index 03e800bd9..c4832322a 100644 --- a/versioned_docs/version-2.13/reference/targets/helm_unittest_test.mdx +++ b/versioned_docs/version-2.13/reference/targets/helm_unittest_test.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_test +description: | + A single helm-unittest suite file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/helm_unittest_tests.mdx b/versioned_docs/version-2.13/reference/targets/helm_unittest_tests.mdx index f045df82b..5b741da6b 100644 --- a/versioned_docs/version-2.13/reference/targets/helm_unittest_tests.mdx +++ b/versioned_docs/version-2.13/reference/targets/helm_unittest_tests.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_tests +description: | + Generates a `helm_unittest_test` target per each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/java_source.mdx b/versioned_docs/version-2.13/reference/targets/java_source.mdx index b6b64af14..cc3337626 100644 --- a/versioned_docs/version-2.13/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.13/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/java_sources.mdx b/versioned_docs/version-2.13/reference/targets/java_sources.mdx index bf8b41677..33507e680 100644 --- a/versioned_docs/version-2.13/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.13/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/junit_test.mdx b/versioned_docs/version-2.13/reference/targets/junit_test.mdx index cbce10820..a5f6b6719 100644 --- a/versioned_docs/version-2.13/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.13/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/junit_tests.mdx b/versioned_docs/version-2.13/reference/targets/junit_tests.mdx index c65ed87f0..117976f54 100644 --- a/versioned_docs/version-2.13/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.13/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.13/reference/targets/jvm_artifact.mdx index 18b53450b..9b4266389 100644 --- a/versioned_docs/version-2.13/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.13/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/jvm_war.mdx b/versioned_docs/version-2.13/reference/targets/jvm_war.mdx index 8e5278c97..095f00c67 100644 --- a/versioned_docs/version-2.13/reference/targets/jvm_war.mdx +++ b/versioned_docs/version-2.13/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/kotlin_junit_test.mdx b/versioned_docs/version-2.13/reference/targets/kotlin_junit_test.mdx index e3f4b64b6..6ccceac64 100644 --- a/versioned_docs/version-2.13/reference/targets/kotlin_junit_test.mdx +++ b/versioned_docs/version-2.13/reference/targets/kotlin_junit_test.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_test +description: | + A single Kotlin test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/kotlin_junit_tests.mdx b/versioned_docs/version-2.13/reference/targets/kotlin_junit_tests.mdx index 0e0789a0a..2929131b2 100644 --- a/versioned_docs/version-2.13/reference/targets/kotlin_junit_tests.mdx +++ b/versioned_docs/version-2.13/reference/targets/kotlin_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_tests +description: | + Generate a `kotlin_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/kotlin_source.mdx b/versioned_docs/version-2.13/reference/targets/kotlin_source.mdx index 0481bc87e..3a2784878 100644 --- a/versioned_docs/version-2.13/reference/targets/kotlin_source.mdx +++ b/versioned_docs/version-2.13/reference/targets/kotlin_source.mdx @@ -1,5 +1,7 @@ --- title: kotlin_source +description: | + A single Kotlin source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/kotlin_sources.mdx b/versioned_docs/version-2.13/reference/targets/kotlin_sources.mdx index b49896868..406e5eab8 100644 --- a/versioned_docs/version-2.13/reference/targets/kotlin_sources.mdx +++ b/versioned_docs/version-2.13/reference/targets/kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: kotlin_sources +description: | + Generate a `kotlin_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/kotlinc_plugin.mdx b/versioned_docs/version-2.13/reference/targets/kotlinc_plugin.mdx index 5facbbddf..d852ce371 100644 --- a/versioned_docs/version-2.13/reference/targets/kotlinc_plugin.mdx +++ b/versioned_docs/version-2.13/reference/targets/kotlinc_plugin.mdx @@ -1,5 +1,7 @@ --- title: kotlinc_plugin +description: | + A plugin for `kotlinc`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.13/reference/targets/pants_requirements.mdx index b8f9710c3..e125d40ce 100644 --- a/versioned_docs/version-2.13/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.13/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.13/reference/targets/pex_binaries.mdx index 551ca3be4..025ddeea5 100644 --- a/versioned_docs/version-2.13/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.13/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/pex_binary.mdx b/versioned_docs/version-2.13/reference/targets/pex_binary.mdx index 9a54cc757..2a433b7e2 100644 --- a/versioned_docs/version-2.13/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.13/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.13/reference/targets/pipenv_requirements.mdx index 1a319f31a..456d214f0 100644 --- a/versioned_docs/version-2.13/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.13/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.13/reference/targets/poetry_requirements.mdx index 344c86b2f..eed2cdde4 100644 --- a/versioned_docs/version-2.13/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.13/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry pyproject.toml. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.13/reference/targets/protobuf_source.mdx index 25dc8b8e1..9a7aa27fc 100644 --- a/versioned_docs/version-2.13/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.13/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.13/reference/targets/protobuf_sources.mdx index 3645c8e72..2eca30688 100644 --- a/versioned_docs/version-2.13/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.13/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.13/reference/targets/pyoxidizer_binary.mdx index e98655bed..df3f9cadb 100644 --- a/versioned_docs/version-2.13/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.13/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.13/reference/targets/python_awslambda.mdx index 51fd8a1ff..712de2874 100644 --- a/versioned_docs/version-2.13/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_distribution.mdx b/versioned_docs/version-2.13/reference/targets/python_distribution.mdx index ac154a90a..2d43238cb 100644 --- a/versioned_docs/version-2.13/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.13/reference/targets/python_google_cloud_function.mdx index 413e364e6..ecbbf6299 100644 --- a/versioned_docs/version-2.13/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_requirement.mdx b/versioned_docs/version-2.13/reference/targets/python_requirement.mdx index 7fd66659c..71b408e59 100644 --- a/versioned_docs/version-2.13/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_requirements.mdx b/versioned_docs/version-2.13/reference/targets/python_requirements.mdx index 6fba0b9aa..0d6ee928b 100644 --- a/versioned_docs/version-2.13/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style file from the `source` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_source.mdx b/versioned_docs/version-2.13/reference/targets/python_source.mdx index cb1361e63..e21036cf9 100644 --- a/versioned_docs/version-2.13/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_sources.mdx b/versioned_docs/version-2.13/reference/targets/python_sources.mdx index 62d48a5b7..73070abc3 100644 --- a/versioned_docs/version-2.13/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_test.mdx b/versioned_docs/version-2.13/reference/targets/python_test.mdx index 92bf076de..eb4d35602 100644 --- a/versioned_docs/version-2.13/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.13/reference/targets/python_test_utils.mdx index 2c84de3dd..e10dc7949 100644 --- a/versioned_docs/version-2.13/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/python_tests.mdx b/versioned_docs/version-2.13/reference/targets/python_tests.mdx index 1ce2664fe..24ce58358 100644 --- a/versioned_docs/version-2.13/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.13/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/relocated_files.mdx b/versioned_docs/version-2.13/reference/targets/relocated_files.mdx index b920f40cd..27951f1bf 100644 --- a/versioned_docs/version-2.13/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.13/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/resource.mdx b/versioned_docs/version-2.13/reference/targets/resource.mdx index f3f266a57..b04206e88 100644 --- a/versioned_docs/version-2.13/reference/targets/resource.mdx +++ b/versioned_docs/version-2.13/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/resources.mdx b/versioned_docs/version-2.13/reference/targets/resources.mdx index 18612e4c6..778314192 100644 --- a/versioned_docs/version-2.13/reference/targets/resources.mdx +++ b/versioned_docs/version-2.13/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.13/reference/targets/scala_junit_test.mdx index 785025062..1765cfe1b 100644 --- a/versioned_docs/version-2.13/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.13/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.13/reference/targets/scala_junit_tests.mdx index 1e5f1df20..183fcfaef 100644 --- a/versioned_docs/version-2.13/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.13/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/scala_source.mdx b/versioned_docs/version-2.13/reference/targets/scala_source.mdx index ba88818e6..227fc8fa8 100644 --- a/versioned_docs/version-2.13/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.13/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/scala_sources.mdx b/versioned_docs/version-2.13/reference/targets/scala_sources.mdx index 95db799b9..9abca65db 100644 --- a/versioned_docs/version-2.13/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.13/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.13/reference/targets/scalac_plugin.mdx index 2d5fa0e60..8253ded67 100644 --- a/versioned_docs/version-2.13/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.13/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.13/reference/targets/scalatest_test.mdx index 903f566b2..7e56f8549 100644 --- a/versioned_docs/version-2.13/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.13/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.13/reference/targets/scalatest_tests.mdx index a54f9c7c0..46f848ff7 100644 --- a/versioned_docs/version-2.13/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.13/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching ('*Spec.scala', '*Suite.scala')). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/shell_source.mdx b/versioned_docs/version-2.13/reference/targets/shell_source.mdx index 75dff950b..892e88d56 100644 --- a/versioned_docs/version-2.13/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.13/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/shell_sources.mdx b/versioned_docs/version-2.13/reference/targets/shell_sources.mdx index 1d612a26b..a510d7bd4 100644 --- a/versioned_docs/version-2.13/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.13/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.13/reference/targets/shunit2_test.mdx index f34cbe7eb..5a68a6ad4 100644 --- a/versioned_docs/version-2.13/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.13/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.13/reference/targets/shunit2_tests.mdx index 3698400f9..063813c53 100644 --- a/versioned_docs/version-2.13/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.13/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/target.mdx b/versioned_docs/version-2.13/reference/targets/target.mdx index 8f92ef968..b0837d4d1 100644 --- a/versioned_docs/version-2.13/reference/targets/target.mdx +++ b/versioned_docs/version-2.13/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/terraform_module.mdx b/versioned_docs/version-2.13/reference/targets/terraform_module.mdx index 3329e661b..3e681e89a 100644 --- a/versioned_docs/version-2.13/reference/targets/terraform_module.mdx +++ b/versioned_docs/version-2.13/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/thrift_source.mdx b/versioned_docs/version-2.13/reference/targets/thrift_source.mdx index 79e0da4dd..e543d5091 100644 --- a/versioned_docs/version-2.13/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.13/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.13/reference/targets/thrift_sources.mdx index 88278c020..8f7efab44 100644 --- a/versioned_docs/version-2.13/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.13/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.13/reference/targets/vcs_version.mdx b/versioned_docs/version-2.13/reference/targets/vcs_version.mdx index 411e377ea..9b3b2353e 100644 --- a/versioned_docs/version-2.13/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.13/reference/targets/vcs_version.mdx @@ -1,5 +1,7 @@ --- title: vcs_version +description: | + Generates a version string from VCS state. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/global-options.mdx b/versioned_docs/version-2.14/reference/global-options.mdx index 7d9626409..12051d5ae 100644 --- a/versioned_docs/version-2.14/reference/global-options.mdx +++ b/versioned_docs/version-2.14/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/check.mdx b/versioned_docs/version-2.14/reference/goals/check.mdx index b93bfef53..f2df10107 100644 --- a/versioned_docs/version-2.14/reference/goals/check.mdx +++ b/versioned_docs/version-2.14/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/count-loc.mdx b/versioned_docs/version-2.14/reference/goals/count-loc.mdx index a14d82313..939b640ef 100644 --- a/versioned_docs/version-2.14/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.14/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/dependees.mdx b/versioned_docs/version-2.14/reference/goals/dependees.mdx index acb819666..560573de6 100644 --- a/versioned_docs/version-2.14/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.14/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/dependencies.mdx b/versioned_docs/version-2.14/reference/goals/dependencies.mdx index 93b182070..8becbfbd4 100644 --- a/versioned_docs/version-2.14/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.14/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.14/reference/goals/experimental-bsp.mdx index 43b3b3123..8747d33cb 100644 --- a/versioned_docs/version-2.14/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.14/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/experimental-deploy.mdx b/versioned_docs/version-2.14/reference/goals/experimental-deploy.mdx index 7745c2304..c4e8d7cb4 100644 --- a/versioned_docs/version-2.14/reference/goals/experimental-deploy.mdx +++ b/versioned_docs/version-2.14/reference/goals/experimental-deploy.mdx @@ -1,5 +1,7 @@ --- title: experimental-deploy +description: | + Perform a deployment process. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/experimental-explorer.mdx b/versioned_docs/version-2.14/reference/goals/experimental-explorer.mdx index eb5e42352..7df90e7dc 100644 --- a/versioned_docs/version-2.14/reference/goals/experimental-explorer.mdx +++ b/versioned_docs/version-2.14/reference/goals/experimental-explorer.mdx @@ -1,5 +1,7 @@ --- title: experimental-explorer +description: | + Run the Pants Explorer Web UI server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/export-codegen.mdx b/versioned_docs/version-2.14/reference/goals/export-codegen.mdx index 7d0521f8b..5782efce3 100644 --- a/versioned_docs/version-2.14/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.14/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/export.mdx b/versioned_docs/version-2.14/reference/goals/export.mdx index 46031e0d2..64dbe72c1 100644 --- a/versioned_docs/version-2.14/reference/goals/export.mdx +++ b/versioned_docs/version-2.14/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/filedeps.mdx b/versioned_docs/version-2.14/reference/goals/filedeps.mdx index b1792afc5..5add97b3e 100644 --- a/versioned_docs/version-2.14/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.14/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/fmt.mdx b/versioned_docs/version-2.14/reference/goals/fmt.mdx index 6f81727c3..a0c8aac02 100644 --- a/versioned_docs/version-2.14/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.14/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.14/reference/goals/generate-lockfiles.mdx index 4b9e3e4ea..8d4b691bd 100644 --- a/versioned_docs/version-2.14/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.14/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for Python third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/help-advanced.mdx b/versioned_docs/version-2.14/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.14/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.14/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/help-all.mdx b/versioned_docs/version-2.14/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.14/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.14/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/help.mdx b/versioned_docs/version-2.14/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.14/reference/goals/help.mdx +++ b/versioned_docs/version-2.14/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/lint.mdx b/versioned_docs/version-2.14/reference/goals/lint.mdx index 80011ac4f..10826ae06 100644 --- a/versioned_docs/version-2.14/reference/goals/lint.mdx +++ b/versioned_docs/version-2.14/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/list.mdx b/versioned_docs/version-2.14/reference/goals/list.mdx index c5ef8723d..706d25072 100644 --- a/versioned_docs/version-2.14/reference/goals/list.mdx +++ b/versioned_docs/version-2.14/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/package.mdx b/versioned_docs/version-2.14/reference/goals/package.mdx index 68d6f1a15..24ad7cd18 100644 --- a/versioned_docs/version-2.14/reference/goals/package.mdx +++ b/versioned_docs/version-2.14/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/paths.mdx b/versioned_docs/version-2.14/reference/goals/paths.mdx index 295e9b09f..b397170c9 100644 --- a/versioned_docs/version-2.14/reference/goals/paths.mdx +++ b/versioned_docs/version-2.14/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/peek.mdx b/versioned_docs/version-2.14/reference/goals/peek.mdx index 210dab5aa..1bed8ccbb 100644 --- a/versioned_docs/version-2.14/reference/goals/peek.mdx +++ b/versioned_docs/version-2.14/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/publish.mdx b/versioned_docs/version-2.14/reference/goals/publish.mdx index 4e1dc7a48..216940ab1 100644 --- a/versioned_docs/version-2.14/reference/goals/publish.mdx +++ b/versioned_docs/version-2.14/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/py-constraints.mdx b/versioned_docs/version-2.14/reference/goals/py-constraints.mdx index 4224739e2..5ec362562 100644 --- a/versioned_docs/version-2.14/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.14/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/repl.mdx b/versioned_docs/version-2.14/reference/goals/repl.mdx index 4ff3fac45..234449746 100644 --- a/versioned_docs/version-2.14/reference/goals/repl.mdx +++ b/versioned_docs/version-2.14/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/roots.mdx b/versioned_docs/version-2.14/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.14/reference/goals/roots.mdx +++ b/versioned_docs/version-2.14/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/run.mdx b/versioned_docs/version-2.14/reference/goals/run.mdx index fd6ba04ff..e63f976f7 100644 --- a/versioned_docs/version-2.14/reference/goals/run.mdx +++ b/versioned_docs/version-2.14/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/tailor.mdx b/versioned_docs/version-2.14/reference/goals/tailor.mdx index 0528d7ac2..0df57809e 100644 --- a/versioned_docs/version-2.14/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.14/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/test.mdx b/versioned_docs/version-2.14/reference/goals/test.mdx index 6cc491619..9717b2ce6 100644 --- a/versioned_docs/version-2.14/reference/goals/test.mdx +++ b/versioned_docs/version-2.14/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/update-build-files.mdx b/versioned_docs/version-2.14/reference/goals/update-build-files.mdx index db81c22c4..4a587e09a 100644 --- a/versioned_docs/version-2.14/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.14/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/goals/version.mdx b/versioned_docs/version-2.14/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.14/reference/goals/version.mdx +++ b/versioned_docs/version-2.14/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.14/reference/subsystems/anonymous-telemetry.mdx index cd7a33087..021ee8983 100644 --- a/versioned_docs/version-2.14/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.14/reference/subsystems/apache-thrift.mdx index 32fe0a891..2b9ce0a09 100644 --- a/versioned_docs/version-2.14/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.14/reference/subsystems/autoflake.mdx index cc570e362..d2214126e 100644 --- a/versioned_docs/version-2.14/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/bandit.mdx b/versioned_docs/version-2.14/reference/subsystems/bandit.mdx index 9fe3705ca..d8fedd746 100644 --- a/versioned_docs/version-2.14/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/black.mdx b/versioned_docs/version-2.14/reference/subsystems/black.mdx index fd92abd5c..c0c206622 100644 --- a/versioned_docs/version-2.14/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/buf.mdx b/versioned_docs/version-2.14/reference/subsystems/buf.mdx index 4d5dc8501..fe3da99a4 100644 --- a/versioned_docs/version-2.14/reference/subsystems/buf.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/buildifier.mdx b/versioned_docs/version-2.14/reference/subsystems/buildifier.mdx index 3d9cd440b..6a2fb2e43 100644 --- a/versioned_docs/version-2.14/reference/subsystems/buildifier.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/buildifier.mdx @@ -1,5 +1,7 @@ --- title: buildifier +description: | + Buildifier is a tool for formatting BUILD files with a standard convention. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/changed.mdx b/versioned_docs/version-2.14/reference/subsystems/changed.mdx index afc26799a..ca2b47e7d 100644 --- a/versioned_docs/version-2.14/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/cli.mdx b/versioned_docs/version-2.14/reference/subsystems/cli.mdx index c0442a850..8360e3d72 100644 --- a/versioned_docs/version-2.14/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/coursier.mdx b/versioned_docs/version-2.14/reference/subsystems/coursier.mdx index 6b6f53b2d..6978f6d96 100644 --- a/versioned_docs/version-2.14/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. (https://get-coursier.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.14/reference/subsystems/coverage-py.mdx index ffb76aaad..2b07c28c3 100644 --- a/versioned_docs/version-2.14/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/debug-adapter.mdx b/versioned_docs/version-2.14/reference/subsystems/debug-adapter.mdx index d15f05658..655c51060 100644 --- a/versioned_docs/version-2.14/reference/subsystems/debug-adapter.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/debug-adapter.mdx @@ -1,5 +1,7 @@ --- title: debug-adapter +description: | + Options used to configure and launch a Debug Adapter server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/debugpy.mdx b/versioned_docs/version-2.14/reference/subsystems/debugpy.mdx index ae60bc68f..a98011712 100644 --- a/versioned_docs/version-2.14/reference/subsystems/debugpy.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/debugpy.mdx @@ -1,5 +1,7 @@ --- title: debugpy +description: | + An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.14/reference/subsystems/docformatter.mdx index 2632633dc..8e0e493ff 100644 --- a/versioned_docs/version-2.14/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/docker.mdx b/versioned_docs/version-2.14/reference/subsystems/docker.mdx index 5495bedb1..284ae93bd 100644 --- a/versioned_docs/version-2.14/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.14/reference/subsystems/dockerfile-parser.mdx index 249297981..025b1dcbd 100644 --- a/versioned_docs/version-2.14/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/download-terraform.mdx b/versioned_docs/version-2.14/reference/subsystems/download-terraform.mdx index 0cda0248c..a0b87820c 100644 --- a/versioned_docs/version-2.14/reference/subsystems/download-terraform.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/filter.mdx b/versioned_docs/version-2.14/reference/subsystems/filter.mdx index 2a6c4cef6..490732a64 100644 --- a/versioned_docs/version-2.14/reference/subsystems/filter.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/flake8.mdx b/versioned_docs/version-2.14/reference/subsystems/flake8.mdx index 778340ba9..8402445ab 100644 --- a/versioned_docs/version-2.14/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/go-test.mdx b/versioned_docs/version-2.14/reference/subsystems/go-test.mdx index 346bffc5d..c87b9ebe5 100644 --- a/versioned_docs/version-2.14/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.14/reference/subsystems/gofmt.mdx index 1334d2574..6ef3bbc06 100644 --- a/versioned_docs/version-2.14/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/golang.mdx b/versioned_docs/version-2.14/reference/subsystems/golang.mdx index d1815c194..877ea4c30 100644 --- a/versioned_docs/version-2.14/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.14/reference/subsystems/google-java-format.mdx index fe5a6ba33..241c48978 100644 --- a/versioned_docs/version-2.14/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.14/reference/subsystems/grpc-python-plugin.mdx index c9e8ae6f7..87ba2a196 100644 --- a/versioned_docs/version-2.14/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.14/reference/subsystems/hadolint.mdx index 3dabe9931..b77f559a4 100644 --- a/versioned_docs/version-2.14/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/helm-k8s-parser.mdx b/versioned_docs/version-2.14/reference/subsystems/helm-k8s-parser.mdx index 79d3f2583..029f40483 100644 --- a/versioned_docs/version-2.14/reference/subsystems/helm-k8s-parser.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/helm-k8s-parser.mdx @@ -1,5 +1,7 @@ --- title: helm-k8s-parser +description: | + Analyses K8S manifests rendered by Helm. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/helm-post-renderer.mdx b/versioned_docs/version-2.14/reference/subsystems/helm-post-renderer.mdx index cae478ffc..11afb56ce 100644 --- a/versioned_docs/version-2.14/reference/subsystems/helm-post-renderer.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/helm-post-renderer.mdx @@ -1,5 +1,7 @@ --- title: helm-post-renderer +description: | + Used perform modifications to the final output produced by Helm charts when they've been fully rendered. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/helm-unittest.mdx b/versioned_docs/version-2.14/reference/subsystems/helm-unittest.mdx index be0aa81b3..6a3161f0d 100644 --- a/versioned_docs/version-2.14/reference/subsystems/helm-unittest.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/helm-unittest.mdx @@ -1,5 +1,7 @@ --- title: helm-unittest +description: | + BDD styled unit test framework for Kubernetes Helm charts as a Helm plugin. (https://github.com/quintush/helm-unittest) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/helm.mdx b/versioned_docs/version-2.14/reference/subsystems/helm.mdx index 8b28dd028..3aec8afc8 100644 --- a/versioned_docs/version-2.14/reference/subsystems/helm.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/ipython.mdx b/versioned_docs/version-2.14/reference/subsystems/ipython.mdx index 8966dca8c..032daec2a 100644 --- a/versioned_docs/version-2.14/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/isort.mdx b/versioned_docs/version-2.14/reference/subsystems/isort.mdx index ddc489068..69286edb7 100644 --- a/versioned_docs/version-2.14/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.14/reference/subsystems/java-infer.mdx index 9b365727f..2088e9ff2 100644 --- a/versioned_docs/version-2.14/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/javac.mdx b/versioned_docs/version-2.14/reference/subsystems/javac.mdx index 32f80db89..a7ac13086 100644 --- a/versioned_docs/version-2.14/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/junit.mdx b/versioned_docs/version-2.14/reference/subsystems/junit.mdx index eed960358..c4b5562bc 100644 --- a/versioned_docs/version-2.14/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/jvm.mdx b/versioned_docs/version-2.14/reference/subsystems/jvm.mdx index f28a0a50e..52039c79f 100644 --- a/versioned_docs/version-2.14/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/kotlin-infer.mdx b/versioned_docs/version-2.14/reference/subsystems/kotlin-infer.mdx index 1241c712c..89eb838c9 100644 --- a/versioned_docs/version-2.14/reference/subsystems/kotlin-infer.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/kotlin-infer.mdx @@ -1,5 +1,7 @@ --- title: kotlin-infer +description: | + Options controlling which dependencies will be inferred for Kotlin targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/kotlin.mdx b/versioned_docs/version-2.14/reference/subsystems/kotlin.mdx index 25b150315..50785c245 100644 --- a/versioned_docs/version-2.14/reference/subsystems/kotlin.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/kotlin.mdx @@ -1,5 +1,7 @@ --- title: kotlin +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/kotlinc.mdx b/versioned_docs/version-2.14/reference/subsystems/kotlinc.mdx index 428423319..3c9d68d40 100644 --- a/versioned_docs/version-2.14/reference/subsystems/kotlinc.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/kotlinc.mdx @@ -1,5 +1,7 @@ --- title: kotlinc +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.14/reference/subsystems/ktlint.mdx index 507b35aea..7dee1a7c0 100644 --- a/versioned_docs/version-2.14/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/ktlint.mdx @@ -1,5 +1,7 @@ --- title: ktlint +description: | + Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.14/reference/subsystems/lambdex.mdx index 1e24eb34c..6a46607a0 100644 --- a/versioned_docs/version-2.14/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.14/reference/subsystems/mypy-protobuf.mdx index 3997ee257..2da86b448 100644 --- a/versioned_docs/version-2.14/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/mypy.mdx b/versioned_docs/version-2.14/reference/subsystems/mypy.mdx index 420501114..4241f344a 100644 --- a/versioned_docs/version-2.14/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.14/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.14/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.14/reference/subsystems/pex-cli.mdx index 96a80a109..f8093fa31 100644 --- a/versioned_docs/version-2.14/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/pex.mdx b/versioned_docs/version-2.14/reference/subsystems/pex.mdx index f908d512e..43cbd3007 100644 --- a/versioned_docs/version-2.14/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/poetry.mdx b/versioned_docs/version-2.14/reference/subsystems/poetry.mdx index ce42fc61b..a137645b3 100644 --- a/versioned_docs/version-2.14/reference/subsystems/poetry.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/poetry.mdx @@ -1,5 +1,7 @@ --- title: poetry +description: | + Used to generate lockfiles for third-party Python dependencies (deprecated). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.14/reference/subsystems/protobuf-java-grpc.mdx index c4c74a45b..be07c579b 100644 --- a/versioned_docs/version-2.14/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/protobuf-java-grpc.mdx @@ -1,5 +1,7 @@ --- title: protobuf-java-grpc +description: | + gRPC support for Java Protobuf (https://github.com/grpc/grpc-java) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/protoc.mdx b/versioned_docs/version-2.14/reference/subsystems/protoc.mdx index 733e8f38c..d729cc5f7 100644 --- a/versioned_docs/version-2.14/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/pylint.mdx b/versioned_docs/version-2.14/reference/subsystems/pylint.mdx index 1f4d2717c..89ea64449 100644 --- a/versioned_docs/version-2.14/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.14/reference/subsystems/pyoxidizer.mdx index 1cb75ea22..a07bf7c9a 100644 --- a/versioned_docs/version-2.14/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/pytest.mdx b/versioned_docs/version-2.14/reference/subsystems/pytest.mdx index 78914dc32..d69d0be1d 100644 --- a/versioned_docs/version-2.14/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.14/reference/subsystems/python-bootstrap.mdx index 185479e81..3a75fa3bb 100644 --- a/versioned_docs/version-2.14/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters used by all Pants backends. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.14/reference/subsystems/python-infer.mdx index 7271cc590..1240a3256 100644 --- a/versioned_docs/version-2.14/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.14/reference/subsystems/python-native-code.mdx index b20614544..5fd95d1c8 100644 --- a/versioned_docs/version-2.14/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.14/reference/subsystems/python-protobuf.mdx index 5bd66720f..e884ebdab 100644 --- a/versioned_docs/version-2.14/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.14/reference/subsystems/python-repos.mdx index 149cfffe7..95bc477a7 100644 --- a/versioned_docs/version-2.14/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.14/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/versioned_docs/version-2.14/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/python.mdx b/versioned_docs/version-2.14/reference/subsystems/python.mdx index efe43398f..fc7d099f7 100644 --- a/versioned_docs/version-2.14/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.14/reference/subsystems/pyupgrade.mdx index 450119dcd..a0cf5f38e 100644 --- a/versioned_docs/version-2.14/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.14/reference/subsystems/regex-lint.mdx index f4d161d67..bf470d95c 100644 --- a/versioned_docs/version-2.14/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.14/reference/subsystems/scala-infer.mdx index e1d0849de..f8a953742 100644 --- a/versioned_docs/version-2.14/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/scala.mdx b/versioned_docs/version-2.14/reference/subsystems/scala.mdx index b55c6b2ae..8184f5acf 100644 --- a/versioned_docs/version-2.14/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/scalac.mdx b/versioned_docs/version-2.14/reference/subsystems/scalac.mdx index 93dd5914c..d2ddec7ca 100644 --- a/versioned_docs/version-2.14/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.14/reference/subsystems/scalafmt.mdx index 8990312d6..968b0b50c 100644 --- a/versioned_docs/version-2.14/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.14/reference/subsystems/scalapb.mdx index d92b43b67..1e327d877 100644 --- a/versioned_docs/version-2.14/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.14/reference/subsystems/scalatest.mdx index 5664b6ab1..8aff88f17 100644 --- a/versioned_docs/version-2.14/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/scc.mdx b/versioned_docs/version-2.14/reference/subsystems/scc.mdx index 94e984246..9c010db01 100644 --- a/versioned_docs/version-2.14/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.14/reference/subsystems/setup-py-generation.mdx index 1f5e97187..5f9ca632c 100644 --- a/versioned_docs/version-2.14/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/setuptools-scm.mdx b/versioned_docs/version-2.14/reference/subsystems/setuptools-scm.mdx index 82299419f..8c0d7d98f 100644 --- a/versioned_docs/version-2.14/reference/subsystems/setuptools-scm.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/setuptools-scm.mdx @@ -1,5 +1,7 @@ --- title: setuptools-scm +description: | + A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.14/reference/subsystems/setuptools.mdx index e4af7f09d..c890797ca 100644 --- a/versioned_docs/version-2.14/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.14/reference/subsystems/shell-setup.mdx index b8be26552..d70723e1c 100644 --- a/versioned_docs/version-2.14/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.14/reference/subsystems/shellcheck.mdx index 9270c5138..b9662f308 100644 --- a/versioned_docs/version-2.14/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.14/reference/subsystems/shfmt.mdx index dd6c24c20..d7adc2e96 100644 --- a/versioned_docs/version-2.14/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/source.mdx b/versioned_docs/version-2.14/reference/subsystems/source.mdx index 9e6d2dc9c..84028c05b 100644 --- a/versioned_docs/version-2.14/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/stats.mdx b/versioned_docs/version-2.14/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.14/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.14/reference/subsystems/subprocess-environment.mdx index 4d6f08ef4..74f6557f8 100644 --- a/versioned_docs/version-2.14/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/terraform-fmt.mdx b/versioned_docs/version-2.14/reference/subsystems/terraform-fmt.mdx index 9385aecda..76736c6bb 100644 --- a/versioned_docs/version-2.14/reference/subsystems/terraform-fmt.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/terraform-hcl2-parser.mdx b/versioned_docs/version-2.14/reference/subsystems/terraform-hcl2-parser.mdx index 5374e3b09..0090ac900 100644 --- a/versioned_docs/version-2.14/reference/subsystems/terraform-hcl2-parser.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/terraform-validate.mdx b/versioned_docs/version-2.14/reference/subsystems/terraform-validate.mdx index 72e025349..2dc21d734 100644 --- a/versioned_docs/version-2.14/reference/subsystems/terraform-validate.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/thrift.mdx b/versioned_docs/version-2.14/reference/subsystems/thrift.mdx index 230854701..7a691f82d 100644 --- a/versioned_docs/version-2.14/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/twine.mdx b/versioned_docs/version-2.14/reference/subsystems/twine.mdx index d2185f176..075bbb84c 100644 --- a/versioned_docs/version-2.14/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPI and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/subsystems/yapf.mdx b/versioned_docs/version-2.14/reference/subsystems/yapf.mdx index 34cc09c0e..e1050439f 100644 --- a/versioned_docs/version-2.14/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.14/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.14/reference/targets/archive.mdx b/versioned_docs/version-2.14/reference/targets/archive.mdx index 801685458..921bde6e0 100644 --- a/versioned_docs/version-2.14/reference/targets/archive.mdx +++ b/versioned_docs/version-2.14/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.14/reference/targets/deploy_jar.mdx index 03e3d65f2..1eabe2208 100644 --- a/versioned_docs/version-2.14/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.14/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/docker_image.mdx b/versioned_docs/version-2.14/reference/targets/docker_image.mdx index 041c07a22..49313a78d 100644 --- a/versioned_docs/version-2.14/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.14/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/experimental_run_shell_command.mdx b/versioned_docs/version-2.14/reference/targets/experimental_run_shell_command.mdx index 0d8d50638..2575802cb 100644 --- a/versioned_docs/version-2.14/reference/targets/experimental_run_shell_command.mdx +++ b/versioned_docs/version-2.14/reference/targets/experimental_run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/experimental_shell_command.mdx b/versioned_docs/version-2.14/reference/targets/experimental_shell_command.mdx index c54023389..722cca7c9 100644 --- a/versioned_docs/version-2.14/reference/targets/experimental_shell_command.mdx +++ b/versioned_docs/version-2.14/reference/targets/experimental_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/file.mdx b/versioned_docs/version-2.14/reference/targets/file.mdx index 5af52140f..e6d88fd04 100644 --- a/versioned_docs/version-2.14/reference/targets/file.mdx +++ b/versioned_docs/version-2.14/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/files.mdx b/versioned_docs/version-2.14/reference/targets/files.mdx index 50547451b..fbe1ba759 100644 --- a/versioned_docs/version-2.14/reference/targets/files.mdx +++ b/versioned_docs/version-2.14/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/go_binary.mdx b/versioned_docs/version-2.14/reference/targets/go_binary.mdx index 26351b1ff..9b710af9a 100644 --- a/versioned_docs/version-2.14/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.14/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/go_mod.mdx b/versioned_docs/version-2.14/reference/targets/go_mod.mdx index caeac0e75..0ab3a00d5 100644 --- a/versioned_docs/version-2.14/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.14/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/go_package.mdx b/versioned_docs/version-2.14/reference/targets/go_package.mdx index 125f218d3..7c2dc4c8d 100644 --- a/versioned_docs/version-2.14/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.14/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.14/reference/targets/go_third_party_package.mdx index b4cf0c75f..f50611709 100644 --- a/versioned_docs/version-2.14/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.14/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/helm_artifact.mdx b/versioned_docs/version-2.14/reference/targets/helm_artifact.mdx index 33546af67..1fe4aeb34 100644 --- a/versioned_docs/version-2.14/reference/targets/helm_artifact.mdx +++ b/versioned_docs/version-2.14/reference/targets/helm_artifact.mdx @@ -1,5 +1,7 @@ --- title: helm_artifact +description: | + A third party Helm artifact. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/helm_chart.mdx b/versioned_docs/version-2.14/reference/targets/helm_chart.mdx index 0cb317b0a..34eff4b9d 100644 --- a/versioned_docs/version-2.14/reference/targets/helm_chart.mdx +++ b/versioned_docs/version-2.14/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/helm_deployment.mdx b/versioned_docs/version-2.14/reference/targets/helm_deployment.mdx index d8210ef5b..d351765d1 100644 --- a/versioned_docs/version-2.14/reference/targets/helm_deployment.mdx +++ b/versioned_docs/version-2.14/reference/targets/helm_deployment.mdx @@ -1,5 +1,7 @@ --- title: helm_deployment +description: | + A Helm chart deployment. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/helm_unittest_test.mdx b/versioned_docs/version-2.14/reference/targets/helm_unittest_test.mdx index 749014609..b11a47396 100644 --- a/versioned_docs/version-2.14/reference/targets/helm_unittest_test.mdx +++ b/versioned_docs/version-2.14/reference/targets/helm_unittest_test.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_test +description: | + A single helm-unittest suite file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/helm_unittest_tests.mdx b/versioned_docs/version-2.14/reference/targets/helm_unittest_tests.mdx index 9f4a4362e..c9ba59aa9 100644 --- a/versioned_docs/version-2.14/reference/targets/helm_unittest_tests.mdx +++ b/versioned_docs/version-2.14/reference/targets/helm_unittest_tests.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_tests +description: | + Generates a `helm_unittest_test` target per each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/java_source.mdx b/versioned_docs/version-2.14/reference/targets/java_source.mdx index 8f6643ff9..00a532b0d 100644 --- a/versioned_docs/version-2.14/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.14/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/java_sources.mdx b/versioned_docs/version-2.14/reference/targets/java_sources.mdx index c74b4958c..42927e9b9 100644 --- a/versioned_docs/version-2.14/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.14/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/junit_test.mdx b/versioned_docs/version-2.14/reference/targets/junit_test.mdx index 877e6bfb4..58c6c21ca 100644 --- a/versioned_docs/version-2.14/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.14/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/junit_tests.mdx b/versioned_docs/version-2.14/reference/targets/junit_tests.mdx index 5c70a772a..7f0e332be 100644 --- a/versioned_docs/version-2.14/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.14/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.14/reference/targets/jvm_artifact.mdx index 38392e7ea..cdd14b4a9 100644 --- a/versioned_docs/version-2.14/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.14/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/jvm_war.mdx b/versioned_docs/version-2.14/reference/targets/jvm_war.mdx index 8db67961a..95221e94f 100644 --- a/versioned_docs/version-2.14/reference/targets/jvm_war.mdx +++ b/versioned_docs/version-2.14/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/kotlin_junit_test.mdx b/versioned_docs/version-2.14/reference/targets/kotlin_junit_test.mdx index 8c9e48bb1..f003209db 100644 --- a/versioned_docs/version-2.14/reference/targets/kotlin_junit_test.mdx +++ b/versioned_docs/version-2.14/reference/targets/kotlin_junit_test.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_test +description: | + A single Kotlin test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/kotlin_junit_tests.mdx b/versioned_docs/version-2.14/reference/targets/kotlin_junit_tests.mdx index 06f3f98b1..e77513428 100644 --- a/versioned_docs/version-2.14/reference/targets/kotlin_junit_tests.mdx +++ b/versioned_docs/version-2.14/reference/targets/kotlin_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_tests +description: | + Generate a `kotlin_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/kotlin_source.mdx b/versioned_docs/version-2.14/reference/targets/kotlin_source.mdx index c311373e0..378053dc6 100644 --- a/versioned_docs/version-2.14/reference/targets/kotlin_source.mdx +++ b/versioned_docs/version-2.14/reference/targets/kotlin_source.mdx @@ -1,5 +1,7 @@ --- title: kotlin_source +description: | + A single Kotlin source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/kotlin_sources.mdx b/versioned_docs/version-2.14/reference/targets/kotlin_sources.mdx index b4d16acdf..e0f8011fc 100644 --- a/versioned_docs/version-2.14/reference/targets/kotlin_sources.mdx +++ b/versioned_docs/version-2.14/reference/targets/kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: kotlin_sources +description: | + Generate a `kotlin_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/kotlinc_plugin.mdx b/versioned_docs/version-2.14/reference/targets/kotlinc_plugin.mdx index 5facbbddf..d852ce371 100644 --- a/versioned_docs/version-2.14/reference/targets/kotlinc_plugin.mdx +++ b/versioned_docs/version-2.14/reference/targets/kotlinc_plugin.mdx @@ -1,5 +1,7 @@ --- title: kotlinc_plugin +description: | + A plugin for `kotlinc`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.14/reference/targets/pants_requirements.mdx index 3ee24852c..f3f24a0c7 100644 --- a/versioned_docs/version-2.14/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.14/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.14/reference/targets/pex_binaries.mdx index 7bd63d6a1..853c5cb36 100644 --- a/versioned_docs/version-2.14/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.14/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/pex_binary.mdx b/versioned_docs/version-2.14/reference/targets/pex_binary.mdx index bce516396..336a5094a 100644 --- a/versioned_docs/version-2.14/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.14/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.14/reference/targets/pipenv_requirements.mdx index 1a319f31a..456d214f0 100644 --- a/versioned_docs/version-2.14/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.14/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.14/reference/targets/poetry_requirements.mdx index 344c86b2f..eed2cdde4 100644 --- a/versioned_docs/version-2.14/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.14/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry pyproject.toml. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.14/reference/targets/protobuf_source.mdx index 1e0e81851..cadb6a964 100644 --- a/versioned_docs/version-2.14/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.14/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.14/reference/targets/protobuf_sources.mdx index 96dd979ba..2d06ef105 100644 --- a/versioned_docs/version-2.14/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.14/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.14/reference/targets/pyoxidizer_binary.mdx index 1b4b82772..ca798575a 100644 --- a/versioned_docs/version-2.14/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.14/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.14/reference/targets/python_awslambda.mdx index 65448511a..05ba7e85a 100644 --- a/versioned_docs/version-2.14/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_distribution.mdx b/versioned_docs/version-2.14/reference/targets/python_distribution.mdx index 1c7dfed47..38955cd43 100644 --- a/versioned_docs/version-2.14/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.14/reference/targets/python_google_cloud_function.mdx index 165c21bc8..e8f91fe49 100644 --- a/versioned_docs/version-2.14/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_requirement.mdx b/versioned_docs/version-2.14/reference/targets/python_requirement.mdx index 1026e31f9..b2671816c 100644 --- a/versioned_docs/version-2.14/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_requirements.mdx b/versioned_docs/version-2.14/reference/targets/python_requirements.mdx index 6fba0b9aa..0d6ee928b 100644 --- a/versioned_docs/version-2.14/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style file from the `source` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_source.mdx b/versioned_docs/version-2.14/reference/targets/python_source.mdx index 54b5bec3b..5f8e2dbbf 100644 --- a/versioned_docs/version-2.14/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_sources.mdx b/versioned_docs/version-2.14/reference/targets/python_sources.mdx index 23010ef34..2ed8e2158 100644 --- a/versioned_docs/version-2.14/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_test.mdx b/versioned_docs/version-2.14/reference/targets/python_test.mdx index 103f5fbe6..6aceea791 100644 --- a/versioned_docs/version-2.14/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.14/reference/targets/python_test_utils.mdx index 0d53038bc..a179c4b15 100644 --- a/versioned_docs/version-2.14/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/python_tests.mdx b/versioned_docs/version-2.14/reference/targets/python_tests.mdx index 910a376ec..fda1e5c26 100644 --- a/versioned_docs/version-2.14/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.14/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/relocated_files.mdx b/versioned_docs/version-2.14/reference/targets/relocated_files.mdx index b920f40cd..27951f1bf 100644 --- a/versioned_docs/version-2.14/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.14/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/resource.mdx b/versioned_docs/version-2.14/reference/targets/resource.mdx index ea8968a40..bd798cd3b 100644 --- a/versioned_docs/version-2.14/reference/targets/resource.mdx +++ b/versioned_docs/version-2.14/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/resources.mdx b/versioned_docs/version-2.14/reference/targets/resources.mdx index a25273fb0..d55500765 100644 --- a/versioned_docs/version-2.14/reference/targets/resources.mdx +++ b/versioned_docs/version-2.14/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.14/reference/targets/scala_junit_test.mdx index ff50a2605..43439ecfb 100644 --- a/versioned_docs/version-2.14/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.14/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.14/reference/targets/scala_junit_tests.mdx index def256abf..82963c233 100644 --- a/versioned_docs/version-2.14/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.14/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/scala_source.mdx b/versioned_docs/version-2.14/reference/targets/scala_source.mdx index 3e751d21c..71b9030ae 100644 --- a/versioned_docs/version-2.14/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.14/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/scala_sources.mdx b/versioned_docs/version-2.14/reference/targets/scala_sources.mdx index e858897a5..a0651caa7 100644 --- a/versioned_docs/version-2.14/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.14/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.14/reference/targets/scalac_plugin.mdx index 2d5fa0e60..8253ded67 100644 --- a/versioned_docs/version-2.14/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.14/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.14/reference/targets/scalatest_test.mdx index 921599900..7c141c3f9 100644 --- a/versioned_docs/version-2.14/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.14/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.14/reference/targets/scalatest_tests.mdx index e8aff87a4..185972896 100644 --- a/versioned_docs/version-2.14/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.14/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching ('*Spec.scala', '*Suite.scala')). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/shell_source.mdx b/versioned_docs/version-2.14/reference/targets/shell_source.mdx index 233422236..bc15c2de6 100644 --- a/versioned_docs/version-2.14/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.14/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/shell_sources.mdx b/versioned_docs/version-2.14/reference/targets/shell_sources.mdx index 3ad129b60..bd3d1dd50 100644 --- a/versioned_docs/version-2.14/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.14/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.14/reference/targets/shunit2_test.mdx index 9de2946b4..266787d8b 100644 --- a/versioned_docs/version-2.14/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.14/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.14/reference/targets/shunit2_tests.mdx index fab2482dd..a6ece9a8a 100644 --- a/versioned_docs/version-2.14/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.14/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/target.mdx b/versioned_docs/version-2.14/reference/targets/target.mdx index 792380ad5..e279ede68 100644 --- a/versioned_docs/version-2.14/reference/targets/target.mdx +++ b/versioned_docs/version-2.14/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/terraform_module.mdx b/versioned_docs/version-2.14/reference/targets/terraform_module.mdx index 59f40f8ce..7c3c10373 100644 --- a/versioned_docs/version-2.14/reference/targets/terraform_module.mdx +++ b/versioned_docs/version-2.14/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/thrift_source.mdx b/versioned_docs/version-2.14/reference/targets/thrift_source.mdx index 5075afcf0..1aa615954 100644 --- a/versioned_docs/version-2.14/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.14/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.14/reference/targets/thrift_sources.mdx index 63ba932f7..84023fb37 100644 --- a/versioned_docs/version-2.14/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.14/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.14/reference/targets/vcs_version.mdx b/versioned_docs/version-2.14/reference/targets/vcs_version.mdx index 1b1a60cf8..edfc6aa39 100644 --- a/versioned_docs/version-2.14/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.14/reference/targets/vcs_version.mdx @@ -1,5 +1,7 @@ --- title: vcs_version +description: | + Generates a version string from VCS state. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/global-options.mdx b/versioned_docs/version-2.15/reference/global-options.mdx index eccee020d..33dfda89a 100644 --- a/versioned_docs/version-2.15/reference/global-options.mdx +++ b/versioned_docs/version-2.15/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/check.mdx b/versioned_docs/version-2.15/reference/goals/check.mdx index 4a14984f6..9ec225403 100644 --- a/versioned_docs/version-2.15/reference/goals/check.mdx +++ b/versioned_docs/version-2.15/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/count-loc.mdx b/versioned_docs/version-2.15/reference/goals/count-loc.mdx index fcd1ded48..1a9c711fe 100644 --- a/versioned_docs/version-2.15/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.15/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/dependees.mdx b/versioned_docs/version-2.15/reference/goals/dependees.mdx index f5de8d489..faff6a881 100644 --- a/versioned_docs/version-2.15/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.15/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/dependencies.mdx b/versioned_docs/version-2.15/reference/goals/dependencies.mdx index eecf7ea2a..4d03fb731 100644 --- a/versioned_docs/version-2.15/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.15/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.15/reference/goals/experimental-bsp.mdx index 43b3b3123..8747d33cb 100644 --- a/versioned_docs/version-2.15/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.15/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/experimental-deploy.mdx b/versioned_docs/version-2.15/reference/goals/experimental-deploy.mdx index cedddbdf4..f437c6091 100644 --- a/versioned_docs/version-2.15/reference/goals/experimental-deploy.mdx +++ b/versioned_docs/version-2.15/reference/goals/experimental-deploy.mdx @@ -1,5 +1,7 @@ --- title: experimental-deploy +description: | + Perform a deployment process. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/experimental-explorer.mdx b/versioned_docs/version-2.15/reference/goals/experimental-explorer.mdx index eb5e42352..7df90e7dc 100644 --- a/versioned_docs/version-2.15/reference/goals/experimental-explorer.mdx +++ b/versioned_docs/version-2.15/reference/goals/experimental-explorer.mdx @@ -1,5 +1,7 @@ --- title: experimental-explorer +description: | + Run the Pants Explorer Web UI server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/export-codegen.mdx b/versioned_docs/version-2.15/reference/goals/export-codegen.mdx index eda4b877a..7b0552d0c 100644 --- a/versioned_docs/version-2.15/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.15/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/export.mdx b/versioned_docs/version-2.15/reference/goals/export.mdx index fb31a9d41..d412adc02 100644 --- a/versioned_docs/version-2.15/reference/goals/export.mdx +++ b/versioned_docs/version-2.15/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/filedeps.mdx b/versioned_docs/version-2.15/reference/goals/filedeps.mdx index fadeb17a0..ea3763879 100644 --- a/versioned_docs/version-2.15/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.15/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/fix.mdx b/versioned_docs/version-2.15/reference/goals/fix.mdx index 4f3361096..79748e0e4 100644 --- a/versioned_docs/version-2.15/reference/goals/fix.mdx +++ b/versioned_docs/version-2.15/reference/goals/fix.mdx @@ -1,5 +1,7 @@ --- title: fix +description: | + Autofix source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/fmt.mdx b/versioned_docs/version-2.15/reference/goals/fmt.mdx index 240a8c110..5a36ff102 100644 --- a/versioned_docs/version-2.15/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.15/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.15/reference/goals/generate-lockfiles.mdx index e9d06e50c..f8a3d10ad 100644 --- a/versioned_docs/version-2.15/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.15/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for Python third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/go-generate.mdx b/versioned_docs/version-2.15/reference/goals/go-generate.mdx index 1a3ebcb5c..3cc6f2870 100644 --- a/versioned_docs/version-2.15/reference/goals/go-generate.mdx +++ b/versioned_docs/version-2.15/reference/goals/go-generate.mdx @@ -1,5 +1,7 @@ --- title: go-generate +description: | + Run each command in a package described by a `//go:generate` directive. This is equivalent to running `go generate` on a Go package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/help-advanced.mdx b/versioned_docs/version-2.15/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.15/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.15/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/help-all.mdx b/versioned_docs/version-2.15/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.15/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.15/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/help.mdx b/versioned_docs/version-2.15/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.15/reference/goals/help.mdx +++ b/versioned_docs/version-2.15/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/lint.mdx b/versioned_docs/version-2.15/reference/goals/lint.mdx index 7f3a14f3c..3322e0f51 100644 --- a/versioned_docs/version-2.15/reference/goals/lint.mdx +++ b/versioned_docs/version-2.15/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run linters/formatters/fixers in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/list.mdx b/versioned_docs/version-2.15/reference/goals/list.mdx index 78d49bb55..bc858f973 100644 --- a/versioned_docs/version-2.15/reference/goals/list.mdx +++ b/versioned_docs/version-2.15/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/package.mdx b/versioned_docs/version-2.15/reference/goals/package.mdx index 357be63d3..e6cb234d7 100644 --- a/versioned_docs/version-2.15/reference/goals/package.mdx +++ b/versioned_docs/version-2.15/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/paths.mdx b/versioned_docs/version-2.15/reference/goals/paths.mdx index fb2ee3e5f..3aaeab3e9 100644 --- a/versioned_docs/version-2.15/reference/goals/paths.mdx +++ b/versioned_docs/version-2.15/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/peek.mdx b/versioned_docs/version-2.15/reference/goals/peek.mdx index 7574cdfd3..b4e5df7cb 100644 --- a/versioned_docs/version-2.15/reference/goals/peek.mdx +++ b/versioned_docs/version-2.15/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/publish.mdx b/versioned_docs/version-2.15/reference/goals/publish.mdx index b6e9c59c8..2a90b4bd6 100644 --- a/versioned_docs/version-2.15/reference/goals/publish.mdx +++ b/versioned_docs/version-2.15/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/py-constraints.mdx b/versioned_docs/version-2.15/reference/goals/py-constraints.mdx index b5298c837..09831a733 100644 --- a/versioned_docs/version-2.15/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.15/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/repl.mdx b/versioned_docs/version-2.15/reference/goals/repl.mdx index 68db5eacc..5cb31f80d 100644 --- a/versioned_docs/version-2.15/reference/goals/repl.mdx +++ b/versioned_docs/version-2.15/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/roots.mdx b/versioned_docs/version-2.15/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.15/reference/goals/roots.mdx +++ b/versioned_docs/version-2.15/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/run.mdx b/versioned_docs/version-2.15/reference/goals/run.mdx index 2799f384e..26fec583d 100644 --- a/versioned_docs/version-2.15/reference/goals/run.mdx +++ b/versioned_docs/version-2.15/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/tailor.mdx b/versioned_docs/version-2.15/reference/goals/tailor.mdx index c9bcaed37..0ac3e48ea 100644 --- a/versioned_docs/version-2.15/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.15/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/test.mdx b/versioned_docs/version-2.15/reference/goals/test.mdx index 14c868f49..e3b85aa71 100644 --- a/versioned_docs/version-2.15/reference/goals/test.mdx +++ b/versioned_docs/version-2.15/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/update-build-files.mdx b/versioned_docs/version-2.15/reference/goals/update-build-files.mdx index da06a93ea..bb4a090b8 100644 --- a/versioned_docs/version-2.15/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.15/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/goals/version.mdx b/versioned_docs/version-2.15/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.15/reference/goals/version.mdx +++ b/versioned_docs/version-2.15/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/add-trailing-comma.mdx b/versioned_docs/version-2.15/reference/subsystems/add-trailing-comma.mdx index f62f3b693..fd6019b87 100644 --- a/versioned_docs/version-2.15/reference/subsystems/add-trailing-comma.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/add-trailing-comma.mdx @@ -1,5 +1,7 @@ --- title: add-trailing-comma +description: | + The add-trailing-comma Python code formatter (https://github.com/asottile/add-trailing-comma). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.15/reference/subsystems/anonymous-telemetry.mdx index b2b1f6127..2aba7806c 100644 --- a/versioned_docs/version-2.15/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.15/reference/subsystems/apache-thrift.mdx index 8cd006a9a..ebd400bea 100644 --- a/versioned_docs/version-2.15/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.15/reference/subsystems/autoflake.mdx index 7016c9c56..5acf119d5 100644 --- a/versioned_docs/version-2.15/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/bandit.mdx b/versioned_docs/version-2.15/reference/subsystems/bandit.mdx index 79a9add45..1470aa407 100644 --- a/versioned_docs/version-2.15/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/black.mdx b/versioned_docs/version-2.15/reference/subsystems/black.mdx index e8b294d6e..1a6ad39af 100644 --- a/versioned_docs/version-2.15/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/buf.mdx b/versioned_docs/version-2.15/reference/subsystems/buf.mdx index 82a7e7f70..b26dda9ab 100644 --- a/versioned_docs/version-2.15/reference/subsystems/buf.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/build-deprecations-fixer.mdx b/versioned_docs/version-2.15/reference/subsystems/build-deprecations-fixer.mdx index c3170bbec..a45437e9b 100644 --- a/versioned_docs/version-2.15/reference/subsystems/build-deprecations-fixer.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/build-deprecations-fixer.mdx @@ -1,5 +1,7 @@ --- title: build-deprecations-fixer +description: | + A tool/plugin for fixing BUILD file deprecations (where possible). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/buildifier.mdx b/versioned_docs/version-2.15/reference/subsystems/buildifier.mdx index eebe38ed1..7b4e8504a 100644 --- a/versioned_docs/version-2.15/reference/subsystems/buildifier.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/buildifier.mdx @@ -1,5 +1,7 @@ --- title: buildifier +description: | + Buildifier is a tool for formatting BUILD files with a standard convention. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/changed.mdx b/versioned_docs/version-2.15/reference/subsystems/changed.mdx index 1a7c3a2ab..72bb31c3e 100644 --- a/versioned_docs/version-2.15/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/cli.mdx b/versioned_docs/version-2.15/reference/subsystems/cli.mdx index c0442a850..8360e3d72 100644 --- a/versioned_docs/version-2.15/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/coursier.mdx b/versioned_docs/version-2.15/reference/subsystems/coursier.mdx index cf8548faa..1cb361164 100644 --- a/versioned_docs/version-2.15/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. (https://get-coursier.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.15/reference/subsystems/coverage-py.mdx index e7efba569..356bd621b 100644 --- a/versioned_docs/version-2.15/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/debug-adapter.mdx b/versioned_docs/version-2.15/reference/subsystems/debug-adapter.mdx index d15f05658..655c51060 100644 --- a/versioned_docs/version-2.15/reference/subsystems/debug-adapter.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/debug-adapter.mdx @@ -1,5 +1,7 @@ --- title: debug-adapter +description: | + Options used to configure and launch a Debug Adapter server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/debugpy.mdx b/versioned_docs/version-2.15/reference/subsystems/debugpy.mdx index 3c10203c2..a279e241b 100644 --- a/versioned_docs/version-2.15/reference/subsystems/debugpy.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/debugpy.mdx @@ -1,5 +1,7 @@ --- title: debugpy +description: | + An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.15/reference/subsystems/docformatter.mdx index dcd8e389a..9caedf9cc 100644 --- a/versioned_docs/version-2.15/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/docker.mdx b/versioned_docs/version-2.15/reference/subsystems/docker.mdx index c6a7f22cb..19afc0057 100644 --- a/versioned_docs/version-2.15/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.15/reference/subsystems/dockerfile-parser.mdx index 3c8afcb00..32d5c606a 100644 --- a/versioned_docs/version-2.15/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/download-terraform.mdx b/versioned_docs/version-2.15/reference/subsystems/download-terraform.mdx index c0b10cbe2..eda707f8e 100644 --- a/versioned_docs/version-2.15/reference/subsystems/download-terraform.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/environments-preview.mdx b/versioned_docs/version-2.15/reference/subsystems/environments-preview.mdx index 780bc8363..8231798c1 100644 --- a/versioned_docs/version-2.15/reference/subsystems/environments-preview.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/environments-preview.mdx @@ -1,5 +1,7 @@ --- title: environments-preview +description: | + A highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/filter.mdx b/versioned_docs/version-2.15/reference/subsystems/filter.mdx index 2a6c4cef6..490732a64 100644 --- a/versioned_docs/version-2.15/reference/subsystems/filter.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/flake8.mdx b/versioned_docs/version-2.15/reference/subsystems/flake8.mdx index 246b11109..c0c678aa2 100644 --- a/versioned_docs/version-2.15/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/go-test.mdx b/versioned_docs/version-2.15/reference/subsystems/go-test.mdx index 0d62b26cb..a52615df2 100644 --- a/versioned_docs/version-2.15/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.15/reference/subsystems/gofmt.mdx index 1334d2574..6ef3bbc06 100644 --- a/versioned_docs/version-2.15/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/golang.mdx b/versioned_docs/version-2.15/reference/subsystems/golang.mdx index 5db552257..703a64e15 100644 --- a/versioned_docs/version-2.15/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.15/reference/subsystems/google-java-format.mdx index 5379a660f..853469d45 100644 --- a/versioned_docs/version-2.15/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.15/reference/subsystems/grpc-python-plugin.mdx index d68f3018a..c48d7ccbe 100644 --- a/versioned_docs/version-2.15/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.15/reference/subsystems/hadolint.mdx index 37dfd8f51..440fd295e 100644 --- a/versioned_docs/version-2.15/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/helm-k8s-parser.mdx b/versioned_docs/version-2.15/reference/subsystems/helm-k8s-parser.mdx index 4aeb495ff..3b2f23752 100644 --- a/versioned_docs/version-2.15/reference/subsystems/helm-k8s-parser.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/helm-k8s-parser.mdx @@ -1,5 +1,7 @@ --- title: helm-k8s-parser +description: | + Analyses K8S manifests rendered by Helm. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/helm-post-renderer.mdx b/versioned_docs/version-2.15/reference/subsystems/helm-post-renderer.mdx index 21de0e96b..c0c994ab2 100644 --- a/versioned_docs/version-2.15/reference/subsystems/helm-post-renderer.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/helm-post-renderer.mdx @@ -1,5 +1,7 @@ --- title: helm-post-renderer +description: | + Used perform modifications to the final output produced by Helm charts when they've been fully rendered. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/helm-unittest.mdx b/versioned_docs/version-2.15/reference/subsystems/helm-unittest.mdx index 354843abc..dfe561b52 100644 --- a/versioned_docs/version-2.15/reference/subsystems/helm-unittest.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/helm-unittest.mdx @@ -1,5 +1,7 @@ --- title: helm-unittest +description: | + BDD styled unit test framework for Kubernetes Helm charts as a Helm plugin. (https://github.com/quintush/helm-unittest) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/helm.mdx b/versioned_docs/version-2.15/reference/subsystems/helm.mdx index 44e508399..051e6d082 100644 --- a/versioned_docs/version-2.15/reference/subsystems/helm.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/ipython.mdx b/versioned_docs/version-2.15/reference/subsystems/ipython.mdx index a9f7907ab..ff0cace87 100644 --- a/versioned_docs/version-2.15/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/isort.mdx b/versioned_docs/version-2.15/reference/subsystems/isort.mdx index 8ba26fae4..6faabcb24 100644 --- a/versioned_docs/version-2.15/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.15/reference/subsystems/java-infer.mdx index 9b365727f..2088e9ff2 100644 --- a/versioned_docs/version-2.15/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/javac.mdx b/versioned_docs/version-2.15/reference/subsystems/javac.mdx index 32f80db89..a7ac13086 100644 --- a/versioned_docs/version-2.15/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/junit.mdx b/versioned_docs/version-2.15/reference/subsystems/junit.mdx index fc1eecbfd..d4fda2012 100644 --- a/versioned_docs/version-2.15/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/jvm.mdx b/versioned_docs/version-2.15/reference/subsystems/jvm.mdx index 800cfb402..2dbfde106 100644 --- a/versioned_docs/version-2.15/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/kotlin-infer.mdx b/versioned_docs/version-2.15/reference/subsystems/kotlin-infer.mdx index 1241c712c..89eb838c9 100644 --- a/versioned_docs/version-2.15/reference/subsystems/kotlin-infer.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/kotlin-infer.mdx @@ -1,5 +1,7 @@ --- title: kotlin-infer +description: | + Options controlling which dependencies will be inferred for Kotlin targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/kotlin.mdx b/versioned_docs/version-2.15/reference/subsystems/kotlin.mdx index 25b150315..50785c245 100644 --- a/versioned_docs/version-2.15/reference/subsystems/kotlin.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/kotlin.mdx @@ -1,5 +1,7 @@ --- title: kotlin +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/kotlinc.mdx b/versioned_docs/version-2.15/reference/subsystems/kotlinc.mdx index 428423319..3c9d68d40 100644 --- a/versioned_docs/version-2.15/reference/subsystems/kotlinc.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/kotlinc.mdx @@ -1,5 +1,7 @@ --- title: kotlinc +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.15/reference/subsystems/ktlint.mdx index fc0250708..82062eadf 100644 --- a/versioned_docs/version-2.15/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/ktlint.mdx @@ -1,5 +1,7 @@ --- title: ktlint +description: | + Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.15/reference/subsystems/lambdex.mdx index ea754766f..7f6fbf176 100644 --- a/versioned_docs/version-2.15/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.15/reference/subsystems/mypy-protobuf.mdx index 5b1ec7d0b..e5954bbdb 100644 --- a/versioned_docs/version-2.15/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/mypy.mdx b/versioned_docs/version-2.15/reference/subsystems/mypy.mdx index 72072e05c..368f00a27 100644 --- a/versioned_docs/version-2.15/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/openapi.mdx b/versioned_docs/version-2.15/reference/subsystems/openapi.mdx index e1bf02a46..78c72dfbc 100644 --- a/versioned_docs/version-2.15/reference/subsystems/openapi.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/openapi.mdx @@ -1,5 +1,7 @@ --- title: openapi +description: | + The OpenAPI Specification (https://swagger.io/specification/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.15/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.15/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.15/reference/subsystems/pex-cli.mdx index 1df2f973a..868a52738 100644 --- a/versioned_docs/version-2.15/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/pex.mdx b/versioned_docs/version-2.15/reference/subsystems/pex.mdx index 6562ee0d6..368a1dc0d 100644 --- a/versioned_docs/version-2.15/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.15/reference/subsystems/protobuf-java-grpc.mdx index c6baa1ce0..26af0bba4 100644 --- a/versioned_docs/version-2.15/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/protobuf-java-grpc.mdx @@ -1,5 +1,7 @@ --- title: protobuf-java-grpc +description: | + gRPC support for Java Protobuf (https://github.com/grpc/grpc-java) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/protoc.mdx b/versioned_docs/version-2.15/reference/subsystems/protoc.mdx index 036af7cda..721e586c2 100644 --- a/versioned_docs/version-2.15/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/pylint.mdx b/versioned_docs/version-2.15/reference/subsystems/pylint.mdx index 83769464a..56b3482fd 100644 --- a/versioned_docs/version-2.15/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.15/reference/subsystems/pyoxidizer.mdx index 467287d3f..17d7b3ff9 100644 --- a/versioned_docs/version-2.15/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/pytest.mdx b/versioned_docs/version-2.15/reference/subsystems/pytest.mdx index 2794611cc..bb3a02d8c 100644 --- a/versioned_docs/version-2.15/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.15/reference/subsystems/python-bootstrap.mdx index f91f2a2aa..1100255bb 100644 --- a/versioned_docs/version-2.15/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters used by all Pants backends. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.15/reference/subsystems/python-infer.mdx index 7271cc590..1240a3256 100644 --- a/versioned_docs/version-2.15/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.15/reference/subsystems/python-native-code.mdx index 766ddeedb..dfdb91103 100644 --- a/versioned_docs/version-2.15/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.15/reference/subsystems/python-protobuf.mdx index 55686620b..b99cab618 100644 --- a/versioned_docs/version-2.15/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.15/reference/subsystems/python-repos.mdx index 71d081ab2..1e6ef35ec 100644 --- a/versioned_docs/version-2.15/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.15/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/versioned_docs/version-2.15/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/python.mdx b/versioned_docs/version-2.15/reference/subsystems/python.mdx index e035db2b5..d29f1cc64 100644 --- a/versioned_docs/version-2.15/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.15/reference/subsystems/pyupgrade.mdx index 5eafc495d..e7fee9e79 100644 --- a/versioned_docs/version-2.15/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.15/reference/subsystems/regex-lint.mdx index 210dbb6aa..02ac0631a 100644 --- a/versioned_docs/version-2.15/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.15/reference/subsystems/scala-infer.mdx index e1d0849de..f8a953742 100644 --- a/versioned_docs/version-2.15/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/scala.mdx b/versioned_docs/version-2.15/reference/subsystems/scala.mdx index b55c6b2ae..8184f5acf 100644 --- a/versioned_docs/version-2.15/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/scalac.mdx b/versioned_docs/version-2.15/reference/subsystems/scalac.mdx index 93dd5914c..d2ddec7ca 100644 --- a/versioned_docs/version-2.15/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.15/reference/subsystems/scalafmt.mdx index 21d380cfe..7ea2ddb40 100644 --- a/versioned_docs/version-2.15/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.15/reference/subsystems/scalapb.mdx index a9c6dbe15..567ded99e 100644 --- a/versioned_docs/version-2.15/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.15/reference/subsystems/scalatest.mdx index d98407336..1ce5b6227 100644 --- a/versioned_docs/version-2.15/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/scc.mdx b/versioned_docs/version-2.15/reference/subsystems/scc.mdx index 0c9d84965..d75eb3da5 100644 --- a/versioned_docs/version-2.15/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.15/reference/subsystems/setup-py-generation.mdx index 1f5e97187..5f9ca632c 100644 --- a/versioned_docs/version-2.15/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/setuptools-scm.mdx b/versioned_docs/version-2.15/reference/subsystems/setuptools-scm.mdx index 7d2197e25..ea3dad4d9 100644 --- a/versioned_docs/version-2.15/reference/subsystems/setuptools-scm.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/setuptools-scm.mdx @@ -1,5 +1,7 @@ --- title: setuptools-scm +description: | + A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.15/reference/subsystems/setuptools.mdx index 02b10abb2..fced5effd 100644 --- a/versioned_docs/version-2.15/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.15/reference/subsystems/shell-setup.mdx index bd86c0fb6..de8a06839 100644 --- a/versioned_docs/version-2.15/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.15/reference/subsystems/shellcheck.mdx index 5df867974..43495dad5 100644 --- a/versioned_docs/version-2.15/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.15/reference/subsystems/shfmt.mdx index 20dab307a..3b8d5b90e 100644 --- a/versioned_docs/version-2.15/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/shunit2.mdx b/versioned_docs/version-2.15/reference/subsystems/shunit2.mdx index d12180355..4cf15d353 100644 --- a/versioned_docs/version-2.15/reference/subsystems/shunit2.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/shunit2.mdx @@ -1,5 +1,7 @@ --- title: shunit2 +description: | + shUnit2 is a xUnit framework for Bourne based shell scripts (https://github.com/kward/shunit2) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/source.mdx b/versioned_docs/version-2.15/reference/subsystems/source.mdx index 592711a4b..018ef87b0 100644 --- a/versioned_docs/version-2.15/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/spectral.mdx b/versioned_docs/version-2.15/reference/subsystems/spectral.mdx index 3997e22c9..980e8ee12 100644 --- a/versioned_docs/version-2.15/reference/subsystems/spectral.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/spectral.mdx @@ -1,5 +1,7 @@ --- title: spectral +description: | + A flexible JSON/YAML linter for creating automated style guides (https://github.com/stoplightio/spectral). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/stats.mdx b/versioned_docs/version-2.15/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.15/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.15/reference/subsystems/subprocess-environment.mdx index 83ffd263a..425480c44 100644 --- a/versioned_docs/version-2.15/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/terraform-fmt.mdx b/versioned_docs/version-2.15/reference/subsystems/terraform-fmt.mdx index 9385aecda..76736c6bb 100644 --- a/versioned_docs/version-2.15/reference/subsystems/terraform-fmt.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/terraform-hcl2-parser.mdx b/versioned_docs/version-2.15/reference/subsystems/terraform-hcl2-parser.mdx index e696132b1..a47def6e7 100644 --- a/versioned_docs/version-2.15/reference/subsystems/terraform-hcl2-parser.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/terraform-validate.mdx b/versioned_docs/version-2.15/reference/subsystems/terraform-validate.mdx index 72e025349..2dc21d734 100644 --- a/versioned_docs/version-2.15/reference/subsystems/terraform-validate.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/thrift.mdx b/versioned_docs/version-2.15/reference/subsystems/thrift.mdx index 230854701..7a691f82d 100644 --- a/versioned_docs/version-2.15/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/twine.mdx b/versioned_docs/version-2.15/reference/subsystems/twine.mdx index 45c6b97d5..c71cf781f 100644 --- a/versioned_docs/version-2.15/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPI and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/subsystems/yapf.mdx b/versioned_docs/version-2.15/reference/subsystems/yapf.mdx index 842e540ec..1371f2e14 100644 --- a/versioned_docs/version-2.15/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.15/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.15/reference/targets/archive.mdx b/versioned_docs/version-2.15/reference/targets/archive.mdx index 801685458..921bde6e0 100644 --- a/versioned_docs/version-2.15/reference/targets/archive.mdx +++ b/versioned_docs/version-2.15/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.15/reference/targets/deploy_jar.mdx index 5e415c198..9549fca6a 100644 --- a/versioned_docs/version-2.15/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.15/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/docker_environment.mdx b/versioned_docs/version-2.15/reference/targets/docker_environment.mdx index ba2eb355e..3aec405cf 100644 --- a/versioned_docs/version-2.15/reference/targets/docker_environment.mdx +++ b/versioned_docs/version-2.15/reference/targets/docker_environment.mdx @@ -1,5 +1,7 @@ --- title: docker_environment +description: | + Configuration of a Docker environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/docker_image.mdx b/versioned_docs/version-2.15/reference/targets/docker_image.mdx index fef80da55..98cd1d588 100644 --- a/versioned_docs/version-2.15/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.15/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/experimental_run_shell_command.mdx b/versioned_docs/version-2.15/reference/targets/experimental_run_shell_command.mdx index 9a5cb2137..e60f26a7b 100644 --- a/versioned_docs/version-2.15/reference/targets/experimental_run_shell_command.mdx +++ b/versioned_docs/version-2.15/reference/targets/experimental_run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/experimental_shell_command.mdx b/versioned_docs/version-2.15/reference/targets/experimental_shell_command.mdx index 79e3cab64..ff29c954a 100644 --- a/versioned_docs/version-2.15/reference/targets/experimental_shell_command.mdx +++ b/versioned_docs/version-2.15/reference/targets/experimental_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/file.mdx b/versioned_docs/version-2.15/reference/targets/file.mdx index d33bb3531..c68376690 100644 --- a/versioned_docs/version-2.15/reference/targets/file.mdx +++ b/versioned_docs/version-2.15/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/files.mdx b/versioned_docs/version-2.15/reference/targets/files.mdx index aadc23144..2a7de62fb 100644 --- a/versioned_docs/version-2.15/reference/targets/files.mdx +++ b/versioned_docs/version-2.15/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/go_binary.mdx b/versioned_docs/version-2.15/reference/targets/go_binary.mdx index 26351b1ff..9b710af9a 100644 --- a/versioned_docs/version-2.15/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.15/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/go_mod.mdx b/versioned_docs/version-2.15/reference/targets/go_mod.mdx index caeac0e75..0ab3a00d5 100644 --- a/versioned_docs/version-2.15/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.15/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/go_package.mdx b/versioned_docs/version-2.15/reference/targets/go_package.mdx index 31ffac9ae..bd97fff3f 100644 --- a/versioned_docs/version-2.15/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.15/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.15/reference/targets/go_third_party_package.mdx index 883529445..a03c56a0d 100644 --- a/versioned_docs/version-2.15/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.15/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/helm_artifact.mdx b/versioned_docs/version-2.15/reference/targets/helm_artifact.mdx index 33546af67..1fe4aeb34 100644 --- a/versioned_docs/version-2.15/reference/targets/helm_artifact.mdx +++ b/versioned_docs/version-2.15/reference/targets/helm_artifact.mdx @@ -1,5 +1,7 @@ --- title: helm_artifact +description: | + A third party Helm artifact. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/helm_chart.mdx b/versioned_docs/version-2.15/reference/targets/helm_chart.mdx index 4b9a1657e..5a3805041 100644 --- a/versioned_docs/version-2.15/reference/targets/helm_chart.mdx +++ b/versioned_docs/version-2.15/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/helm_deployment.mdx b/versioned_docs/version-2.15/reference/targets/helm_deployment.mdx index 2df6545bb..3548baf6c 100644 --- a/versioned_docs/version-2.15/reference/targets/helm_deployment.mdx +++ b/versioned_docs/version-2.15/reference/targets/helm_deployment.mdx @@ -1,5 +1,7 @@ --- title: helm_deployment +description: | + A Helm chart deployment. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/helm_unittest_test.mdx b/versioned_docs/version-2.15/reference/targets/helm_unittest_test.mdx index 959af3e8b..84672f29b 100644 --- a/versioned_docs/version-2.15/reference/targets/helm_unittest_test.mdx +++ b/versioned_docs/version-2.15/reference/targets/helm_unittest_test.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_test +description: | + A single helm-unittest suite file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/helm_unittest_tests.mdx b/versioned_docs/version-2.15/reference/targets/helm_unittest_tests.mdx index 12615a4bd..d3c5ee55c 100644 --- a/versioned_docs/version-2.15/reference/targets/helm_unittest_tests.mdx +++ b/versioned_docs/version-2.15/reference/targets/helm_unittest_tests.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_tests +description: | + Generates a `helm_unittest_test` target per each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/java_source.mdx b/versioned_docs/version-2.15/reference/targets/java_source.mdx index e061fc382..f44fa8aeb 100644 --- a/versioned_docs/version-2.15/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.15/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/java_sources.mdx b/versioned_docs/version-2.15/reference/targets/java_sources.mdx index 683689b3a..9d8e015a5 100644 --- a/versioned_docs/version-2.15/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.15/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/junit_test.mdx b/versioned_docs/version-2.15/reference/targets/junit_test.mdx index 6658107d1..eb1943c50 100644 --- a/versioned_docs/version-2.15/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.15/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/junit_tests.mdx b/versioned_docs/version-2.15/reference/targets/junit_tests.mdx index bed3bc8f3..4c3d1272f 100644 --- a/versioned_docs/version-2.15/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.15/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.15/reference/targets/jvm_artifact.mdx index 754a5b761..392f69fe5 100644 --- a/versioned_docs/version-2.15/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.15/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/jvm_war.mdx b/versioned_docs/version-2.15/reference/targets/jvm_war.mdx index c3dfaed9f..8255fd5ed 100644 --- a/versioned_docs/version-2.15/reference/targets/jvm_war.mdx +++ b/versioned_docs/version-2.15/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/kotlin_junit_test.mdx b/versioned_docs/version-2.15/reference/targets/kotlin_junit_test.mdx index d831d86c6..42b8e2cfa 100644 --- a/versioned_docs/version-2.15/reference/targets/kotlin_junit_test.mdx +++ b/versioned_docs/version-2.15/reference/targets/kotlin_junit_test.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_test +description: | + A single Kotlin test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/kotlin_junit_tests.mdx b/versioned_docs/version-2.15/reference/targets/kotlin_junit_tests.mdx index ca082a886..eb265431c 100644 --- a/versioned_docs/version-2.15/reference/targets/kotlin_junit_tests.mdx +++ b/versioned_docs/version-2.15/reference/targets/kotlin_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_tests +description: | + Generate a `kotlin_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/kotlin_source.mdx b/versioned_docs/version-2.15/reference/targets/kotlin_source.mdx index a107c641a..3b8d9c960 100644 --- a/versioned_docs/version-2.15/reference/targets/kotlin_source.mdx +++ b/versioned_docs/version-2.15/reference/targets/kotlin_source.mdx @@ -1,5 +1,7 @@ --- title: kotlin_source +description: | + A single Kotlin source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/kotlin_sources.mdx b/versioned_docs/version-2.15/reference/targets/kotlin_sources.mdx index 7771c226a..ee8de4cf0 100644 --- a/versioned_docs/version-2.15/reference/targets/kotlin_sources.mdx +++ b/versioned_docs/version-2.15/reference/targets/kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: kotlin_sources +description: | + Generate a `kotlin_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/kotlinc_plugin.mdx b/versioned_docs/version-2.15/reference/targets/kotlinc_plugin.mdx index a4095066e..67d034bc6 100644 --- a/versioned_docs/version-2.15/reference/targets/kotlinc_plugin.mdx +++ b/versioned_docs/version-2.15/reference/targets/kotlinc_plugin.mdx @@ -1,5 +1,7 @@ --- title: kotlinc_plugin +description: | + A plugin for `kotlinc`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/local_environment.mdx b/versioned_docs/version-2.15/reference/targets/local_environment.mdx index f58e048aa..427532146 100644 --- a/versioned_docs/version-2.15/reference/targets/local_environment.mdx +++ b/versioned_docs/version-2.15/reference/targets/local_environment.mdx @@ -1,5 +1,7 @@ --- title: local_environment +description: | + Configuration of a local execution environment for specific platforms. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/openapi_document.mdx b/versioned_docs/version-2.15/reference/targets/openapi_document.mdx index 5e70ac15b..4994359de 100644 --- a/versioned_docs/version-2.15/reference/targets/openapi_document.mdx +++ b/versioned_docs/version-2.15/reference/targets/openapi_document.mdx @@ -1,5 +1,7 @@ --- title: openapi_document +description: | + A single OpenAPI document file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/openapi_documents.mdx b/versioned_docs/version-2.15/reference/targets/openapi_documents.mdx index 583e5b7dd..f8b8f661c 100644 --- a/versioned_docs/version-2.15/reference/targets/openapi_documents.mdx +++ b/versioned_docs/version-2.15/reference/targets/openapi_documents.mdx @@ -1,5 +1,7 @@ --- title: openapi_documents +description: | + Generate an `openapi_document` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/openapi_source.mdx b/versioned_docs/version-2.15/reference/targets/openapi_source.mdx index 208c57b30..1ad7939e3 100644 --- a/versioned_docs/version-2.15/reference/targets/openapi_source.mdx +++ b/versioned_docs/version-2.15/reference/targets/openapi_source.mdx @@ -1,5 +1,7 @@ --- title: openapi_source +description: | + A single OpenAPI source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/openapi_sources.mdx b/versioned_docs/version-2.15/reference/targets/openapi_sources.mdx index f7801667a..ba02b5e2a 100644 --- a/versioned_docs/version-2.15/reference/targets/openapi_sources.mdx +++ b/versioned_docs/version-2.15/reference/targets/openapi_sources.mdx @@ -1,5 +1,7 @@ --- title: openapi_sources +description: | + Generate an `openapi_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.15/reference/targets/pants_requirements.mdx index e2626fb8b..52b50e0a7 100644 --- a/versioned_docs/version-2.15/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.15/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.15/reference/targets/pex_binaries.mdx index 7beb5d1bf..0d3566104 100644 --- a/versioned_docs/version-2.15/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.15/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/pex_binary.mdx b/versioned_docs/version-2.15/reference/targets/pex_binary.mdx index f33978fe0..4439d4396 100644 --- a/versioned_docs/version-2.15/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.15/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.15/reference/targets/pipenv_requirements.mdx index 1a319f31a..456d214f0 100644 --- a/versioned_docs/version-2.15/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.15/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.15/reference/targets/poetry_requirements.mdx index 344c86b2f..eed2cdde4 100644 --- a/versioned_docs/version-2.15/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.15/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry pyproject.toml. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.15/reference/targets/protobuf_source.mdx index be8233fe6..a289ce9fa 100644 --- a/versioned_docs/version-2.15/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.15/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.15/reference/targets/protobuf_sources.mdx index ab136120f..b8300e15e 100644 --- a/versioned_docs/version-2.15/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.15/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.15/reference/targets/pyoxidizer_binary.mdx index 181b77d0e..9d3df0056 100644 --- a/versioned_docs/version-2.15/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.15/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.15/reference/targets/python_awslambda.mdx index 0758ce93f..f32d97d4e 100644 --- a/versioned_docs/version-2.15/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_distribution.mdx b/versioned_docs/version-2.15/reference/targets/python_distribution.mdx index ccfcc68d9..169bc6c32 100644 --- a/versioned_docs/version-2.15/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.15/reference/targets/python_google_cloud_function.mdx index 6c37fc2e4..8fcbf889d 100644 --- a/versioned_docs/version-2.15/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_requirement.mdx b/versioned_docs/version-2.15/reference/targets/python_requirement.mdx index 6d0fbb688..2a498a623 100644 --- a/versioned_docs/version-2.15/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_requirements.mdx b/versioned_docs/version-2.15/reference/targets/python_requirements.mdx index 6fba0b9aa..0d6ee928b 100644 --- a/versioned_docs/version-2.15/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style file from the `source` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_source.mdx b/versioned_docs/version-2.15/reference/targets/python_source.mdx index 7689405c6..b61d8e41f 100644 --- a/versioned_docs/version-2.15/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_sources.mdx b/versioned_docs/version-2.15/reference/targets/python_sources.mdx index 2242df48e..9bb4769e9 100644 --- a/versioned_docs/version-2.15/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_test.mdx b/versioned_docs/version-2.15/reference/targets/python_test.mdx index 432255063..484348648 100644 --- a/versioned_docs/version-2.15/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.15/reference/targets/python_test_utils.mdx index 0048aba55..feb351a23 100644 --- a/versioned_docs/version-2.15/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/python_tests.mdx b/versioned_docs/version-2.15/reference/targets/python_tests.mdx index 4d1b03a64..29f5d3e55 100644 --- a/versioned_docs/version-2.15/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.15/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/relocated_files.mdx b/versioned_docs/version-2.15/reference/targets/relocated_files.mdx index b920f40cd..27951f1bf 100644 --- a/versioned_docs/version-2.15/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.15/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/remote_environment.mdx b/versioned_docs/version-2.15/reference/targets/remote_environment.mdx index 1240f745e..409a46817 100644 --- a/versioned_docs/version-2.15/reference/targets/remote_environment.mdx +++ b/versioned_docs/version-2.15/reference/targets/remote_environment.mdx @@ -1,5 +1,7 @@ --- title: remote_environment +description: | + Configuration of a remote execution environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/resource.mdx b/versioned_docs/version-2.15/reference/targets/resource.mdx index d14f752c5..7d5fb2796 100644 --- a/versioned_docs/version-2.15/reference/targets/resource.mdx +++ b/versioned_docs/version-2.15/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/resources.mdx b/versioned_docs/version-2.15/reference/targets/resources.mdx index c1b22a6e0..6932ce825 100644 --- a/versioned_docs/version-2.15/reference/targets/resources.mdx +++ b/versioned_docs/version-2.15/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.15/reference/targets/scala_junit_test.mdx index 3e9bf812e..a2ae08fb6 100644 --- a/versioned_docs/version-2.15/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.15/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.15/reference/targets/scala_junit_tests.mdx index 45517bbe7..24566a49b 100644 --- a/versioned_docs/version-2.15/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.15/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/scala_source.mdx b/versioned_docs/version-2.15/reference/targets/scala_source.mdx index 662081a92..25593507e 100644 --- a/versioned_docs/version-2.15/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.15/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/scala_sources.mdx b/versioned_docs/version-2.15/reference/targets/scala_sources.mdx index 12e99e4ea..cb288c73e 100644 --- a/versioned_docs/version-2.15/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.15/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.15/reference/targets/scalac_plugin.mdx index 2d5fa0e60..8253ded67 100644 --- a/versioned_docs/version-2.15/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.15/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.15/reference/targets/scalatest_test.mdx index 073cd14eb..46152df5b 100644 --- a/versioned_docs/version-2.15/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.15/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.15/reference/targets/scalatest_tests.mdx index 298c2197e..aa6ed66c5 100644 --- a/versioned_docs/version-2.15/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.15/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching ('*Spec.scala', '*Suite.scala')). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/shell_source.mdx b/versioned_docs/version-2.15/reference/targets/shell_source.mdx index e06de7d06..48719473d 100644 --- a/versioned_docs/version-2.15/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.15/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/shell_sources.mdx b/versioned_docs/version-2.15/reference/targets/shell_sources.mdx index 219fdc94b..d57aa70ab 100644 --- a/versioned_docs/version-2.15/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.15/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.15/reference/targets/shunit2_test.mdx index 27d7f5359..799d35f0c 100644 --- a/versioned_docs/version-2.15/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.15/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.15/reference/targets/shunit2_tests.mdx index 7af12b3c6..0c2acee84 100644 --- a/versioned_docs/version-2.15/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.15/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/target.mdx b/versioned_docs/version-2.15/reference/targets/target.mdx index 2592c1a00..50a06301a 100644 --- a/versioned_docs/version-2.15/reference/targets/target.mdx +++ b/versioned_docs/version-2.15/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/terraform_module.mdx b/versioned_docs/version-2.15/reference/targets/terraform_module.mdx index abfb2c32e..784a34966 100644 --- a/versioned_docs/version-2.15/reference/targets/terraform_module.mdx +++ b/versioned_docs/version-2.15/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/thrift_source.mdx b/versioned_docs/version-2.15/reference/targets/thrift_source.mdx index 41f96f851..3f5ef6ee4 100644 --- a/versioned_docs/version-2.15/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.15/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.15/reference/targets/thrift_sources.mdx index be7fe743a..f2a2db133 100644 --- a/versioned_docs/version-2.15/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.15/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.15/reference/targets/vcs_version.mdx b/versioned_docs/version-2.15/reference/targets/vcs_version.mdx index 885841a53..d85419527 100644 --- a/versioned_docs/version-2.15/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.15/reference/targets/vcs_version.mdx @@ -1,5 +1,7 @@ --- title: vcs_version +description: | + Generates a version string from VCS state. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/global-options.mdx b/versioned_docs/version-2.16/reference/global-options.mdx index 40383fe8e..c963ae43c 100644 --- a/versioned_docs/version-2.16/reference/global-options.mdx +++ b/versioned_docs/version-2.16/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/check.mdx b/versioned_docs/version-2.16/reference/goals/check.mdx index 055b4584b..d2b292a1c 100644 --- a/versioned_docs/version-2.16/reference/goals/check.mdx +++ b/versioned_docs/version-2.16/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/count-loc.mdx b/versioned_docs/version-2.16/reference/goals/count-loc.mdx index fcd1ded48..1a9c711fe 100644 --- a/versioned_docs/version-2.16/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.16/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/dependees.mdx b/versioned_docs/version-2.16/reference/goals/dependees.mdx index c8d158961..4033c80d2 100644 --- a/versioned_docs/version-2.16/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.16/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/dependencies.mdx b/versioned_docs/version-2.16/reference/goals/dependencies.mdx index eecf7ea2a..4d03fb731 100644 --- a/versioned_docs/version-2.16/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.16/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/dependents.mdx b/versioned_docs/version-2.16/reference/goals/dependents.mdx index d8f395668..6727ab393 100644 --- a/versioned_docs/version-2.16/reference/goals/dependents.mdx +++ b/versioned_docs/version-2.16/reference/goals/dependents.mdx @@ -1,5 +1,7 @@ --- title: dependents +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.16/reference/goals/experimental-bsp.mdx index 6ffa7f417..fcc748c92 100644 --- a/versioned_docs/version-2.16/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.16/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/experimental-deploy.mdx b/versioned_docs/version-2.16/reference/goals/experimental-deploy.mdx index cedddbdf4..f437c6091 100644 --- a/versioned_docs/version-2.16/reference/goals/experimental-deploy.mdx +++ b/versioned_docs/version-2.16/reference/goals/experimental-deploy.mdx @@ -1,5 +1,7 @@ --- title: experimental-deploy +description: | + Perform a deployment process. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/experimental-explorer.mdx b/versioned_docs/version-2.16/reference/goals/experimental-explorer.mdx index eb5e42352..7df90e7dc 100644 --- a/versioned_docs/version-2.16/reference/goals/experimental-explorer.mdx +++ b/versioned_docs/version-2.16/reference/goals/experimental-explorer.mdx @@ -1,5 +1,7 @@ --- title: experimental-explorer +description: | + Run the Pants Explorer Web UI server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/export-codegen.mdx b/versioned_docs/version-2.16/reference/goals/export-codegen.mdx index 08f5cb08d..5ba91e387 100644 --- a/versioned_docs/version-2.16/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.16/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/export.mdx b/versioned_docs/version-2.16/reference/goals/export.mdx index 9b2d7ba68..52b02276d 100644 --- a/versioned_docs/version-2.16/reference/goals/export.mdx +++ b/versioned_docs/version-2.16/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/filedeps.mdx b/versioned_docs/version-2.16/reference/goals/filedeps.mdx index fadeb17a0..ea3763879 100644 --- a/versioned_docs/version-2.16/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.16/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/fix.mdx b/versioned_docs/version-2.16/reference/goals/fix.mdx index a685b2f1f..13f929340 100644 --- a/versioned_docs/version-2.16/reference/goals/fix.mdx +++ b/versioned_docs/version-2.16/reference/goals/fix.mdx @@ -1,5 +1,7 @@ --- title: fix +description: | + Autofix source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/fmt.mdx b/versioned_docs/version-2.16/reference/goals/fmt.mdx index 240a8c110..5a36ff102 100644 --- a/versioned_docs/version-2.16/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.16/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.16/reference/goals/generate-lockfiles.mdx index 174338416..08068b65d 100644 --- a/versioned_docs/version-2.16/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.16/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/go-generate.mdx b/versioned_docs/version-2.16/reference/goals/go-generate.mdx index 484728cb1..6bc7d2863 100644 --- a/versioned_docs/version-2.16/reference/goals/go-generate.mdx +++ b/versioned_docs/version-2.16/reference/goals/go-generate.mdx @@ -1,5 +1,7 @@ --- title: go-generate +description: | + Run each command in a package described by a `//go:generate` directive. This is equivalent to running `go generate` on a Go package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/help-advanced.mdx b/versioned_docs/version-2.16/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.16/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.16/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/help-all.mdx b/versioned_docs/version-2.16/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.16/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.16/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/help.mdx b/versioned_docs/version-2.16/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.16/reference/goals/help.mdx +++ b/versioned_docs/version-2.16/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/lint.mdx b/versioned_docs/version-2.16/reference/goals/lint.mdx index 3c193f2dd..8173b27bf 100644 --- a/versioned_docs/version-2.16/reference/goals/lint.mdx +++ b/versioned_docs/version-2.16/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run linters/formatters/fixers in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/list.mdx b/versioned_docs/version-2.16/reference/goals/list.mdx index 78d49bb55..bc858f973 100644 --- a/versioned_docs/version-2.16/reference/goals/list.mdx +++ b/versioned_docs/version-2.16/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/package.mdx b/versioned_docs/version-2.16/reference/goals/package.mdx index 357be63d3..e6cb234d7 100644 --- a/versioned_docs/version-2.16/reference/goals/package.mdx +++ b/versioned_docs/version-2.16/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/paths.mdx b/versioned_docs/version-2.16/reference/goals/paths.mdx index fb2ee3e5f..3aaeab3e9 100644 --- a/versioned_docs/version-2.16/reference/goals/paths.mdx +++ b/versioned_docs/version-2.16/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/peek.mdx b/versioned_docs/version-2.16/reference/goals/peek.mdx index f42185cf3..4c54e6307 100644 --- a/versioned_docs/version-2.16/reference/goals/peek.mdx +++ b/versioned_docs/version-2.16/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/publish.mdx b/versioned_docs/version-2.16/reference/goals/publish.mdx index b6e9c59c8..2a90b4bd6 100644 --- a/versioned_docs/version-2.16/reference/goals/publish.mdx +++ b/versioned_docs/version-2.16/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/py-constraints.mdx b/versioned_docs/version-2.16/reference/goals/py-constraints.mdx index bfa54c2ea..8b7039132 100644 --- a/versioned_docs/version-2.16/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.16/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/python-dump-source-analysis.mdx b/versioned_docs/version-2.16/reference/goals/python-dump-source-analysis.mdx index 935e0c1f4..55b086047 100644 --- a/versioned_docs/version-2.16/reference/goals/python-dump-source-analysis.mdx +++ b/versioned_docs/version-2.16/reference/goals/python-dump-source-analysis.mdx @@ -1,5 +1,7 @@ --- title: python-dump-source-analysis +description: | + Dump source analysis for python_source targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/repl.mdx b/versioned_docs/version-2.16/reference/goals/repl.mdx index 68db5eacc..5cb31f80d 100644 --- a/versioned_docs/version-2.16/reference/goals/repl.mdx +++ b/versioned_docs/version-2.16/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/roots.mdx b/versioned_docs/version-2.16/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.16/reference/goals/roots.mdx +++ b/versioned_docs/version-2.16/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/run.mdx b/versioned_docs/version-2.16/reference/goals/run.mdx index 4a26d2e66..0a3c0375e 100644 --- a/versioned_docs/version-2.16/reference/goals/run.mdx +++ b/versioned_docs/version-2.16/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/tailor.mdx b/versioned_docs/version-2.16/reference/goals/tailor.mdx index eccce5d58..f1719a0e2 100644 --- a/versioned_docs/version-2.16/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.16/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/test.mdx b/versioned_docs/version-2.16/reference/goals/test.mdx index 14c868f49..e3b85aa71 100644 --- a/versioned_docs/version-2.16/reference/goals/test.mdx +++ b/versioned_docs/version-2.16/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/update-build-files.mdx b/versioned_docs/version-2.16/reference/goals/update-build-files.mdx index 0aeedf0e4..855731657 100644 --- a/versioned_docs/version-2.16/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.16/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/goals/version.mdx b/versioned_docs/version-2.16/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.16/reference/goals/version.mdx +++ b/versioned_docs/version-2.16/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/add-trailing-comma.mdx b/versioned_docs/version-2.16/reference/subsystems/add-trailing-comma.mdx index 7f8441abd..bf3f49171 100644 --- a/versioned_docs/version-2.16/reference/subsystems/add-trailing-comma.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/add-trailing-comma.mdx @@ -1,5 +1,7 @@ --- title: add-trailing-comma +description: | + The add-trailing-comma Python code formatter (https://github.com/asottile/add-trailing-comma). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.16/reference/subsystems/anonymous-telemetry.mdx index 5fceeec06..e6182fe18 100644 --- a/versioned_docs/version-2.16/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.16/reference/subsystems/apache-thrift.mdx index 8cd006a9a..ebd400bea 100644 --- a/versioned_docs/version-2.16/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.16/reference/subsystems/autoflake.mdx index cff022dd3..5702b9530 100644 --- a/versioned_docs/version-2.16/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/bandit.mdx b/versioned_docs/version-2.16/reference/subsystems/bandit.mdx index 4556ed51a..1e5ef1ecb 100644 --- a/versioned_docs/version-2.16/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/black.mdx b/versioned_docs/version-2.16/reference/subsystems/black.mdx index 321409ab5..c952036d7 100644 --- a/versioned_docs/version-2.16/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/buf.mdx b/versioned_docs/version-2.16/reference/subsystems/buf.mdx index 57aa29e56..f0b0bdf26 100644 --- a/versioned_docs/version-2.16/reference/subsystems/buf.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/build-deprecations-fixer.mdx b/versioned_docs/version-2.16/reference/subsystems/build-deprecations-fixer.mdx index 657c853b8..4d775caf0 100644 --- a/versioned_docs/version-2.16/reference/subsystems/build-deprecations-fixer.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/build-deprecations-fixer.mdx @@ -1,5 +1,7 @@ --- title: build-deprecations-fixer +description: | + A tool/plugin for fixing BUILD file deprecations (where possible). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/buildifier.mdx b/versioned_docs/version-2.16/reference/subsystems/buildifier.mdx index 30018e8ab..465550e6e 100644 --- a/versioned_docs/version-2.16/reference/subsystems/buildifier.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/buildifier.mdx @@ -1,5 +1,7 @@ --- title: buildifier +description: | + Buildifier is a tool for formatting BUILD files with a standard convention. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/changed.mdx b/versioned_docs/version-2.16/reference/subsystems/changed.mdx index 249864f3a..276666521 100644 --- a/versioned_docs/version-2.16/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/cli.mdx b/versioned_docs/version-2.16/reference/subsystems/cli.mdx index 7a12ca8ca..c1d3d782d 100644 --- a/versioned_docs/version-2.16/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/coursier.mdx b/versioned_docs/version-2.16/reference/subsystems/coursier.mdx index 82a3ef5c0..954383e23 100644 --- a/versioned_docs/version-2.16/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. (https://get-coursier.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.16/reference/subsystems/coverage-py.mdx index c7714fe28..37cd9de90 100644 --- a/versioned_docs/version-2.16/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/debug-adapter.mdx b/versioned_docs/version-2.16/reference/subsystems/debug-adapter.mdx index d15f05658..655c51060 100644 --- a/versioned_docs/version-2.16/reference/subsystems/debug-adapter.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/debug-adapter.mdx @@ -1,5 +1,7 @@ --- title: debug-adapter +description: | + Options used to configure and launch a Debug Adapter server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/debugpy.mdx b/versioned_docs/version-2.16/reference/subsystems/debugpy.mdx index baed4295f..629eec789 100644 --- a/versioned_docs/version-2.16/reference/subsystems/debugpy.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/debugpy.mdx @@ -1,5 +1,7 @@ --- title: debugpy +description: | + An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.16/reference/subsystems/docformatter.mdx index 533a20471..6933c7ddd 100644 --- a/versioned_docs/version-2.16/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/docker.mdx b/versioned_docs/version-2.16/reference/subsystems/docker.mdx index 0f4efe0a0..39f5c27c8 100644 --- a/versioned_docs/version-2.16/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.16/reference/subsystems/dockerfile-parser.mdx index cb7e39672..a44d9596e 100644 --- a/versioned_docs/version-2.16/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/download-terraform.mdx b/versioned_docs/version-2.16/reference/subsystems/download-terraform.mdx index ea5c0e923..aab98cd0a 100644 --- a/versioned_docs/version-2.16/reference/subsystems/download-terraform.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/environments-preview.mdx b/versioned_docs/version-2.16/reference/subsystems/environments-preview.mdx index 780bc8363..8231798c1 100644 --- a/versioned_docs/version-2.16/reference/subsystems/environments-preview.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/environments-preview.mdx @@ -1,5 +1,7 @@ --- title: environments-preview +description: | + A highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/filter.mdx b/versioned_docs/version-2.16/reference/subsystems/filter.mdx index 2a6c4cef6..490732a64 100644 --- a/versioned_docs/version-2.16/reference/subsystems/filter.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/flake8.mdx b/versioned_docs/version-2.16/reference/subsystems/flake8.mdx index e8bee2ab2..476024394 100644 --- a/versioned_docs/version-2.16/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/go-test.mdx b/versioned_docs/version-2.16/reference/subsystems/go-test.mdx index fc6b89a6e..79d1494c5 100644 --- a/versioned_docs/version-2.16/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.16/reference/subsystems/gofmt.mdx index 83a3eb9a5..e54bcdc75 100644 --- a/versioned_docs/version-2.16/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/golang.mdx b/versioned_docs/version-2.16/reference/subsystems/golang.mdx index 397e59e03..48f11c4f4 100644 --- a/versioned_docs/version-2.16/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.16/reference/subsystems/google-java-format.mdx index 1b59e190e..69e9ff294 100644 --- a/versioned_docs/version-2.16/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.16/reference/subsystems/grpc-python-plugin.mdx index 1b90fe972..c542a66e3 100644 --- a/versioned_docs/version-2.16/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.16/reference/subsystems/hadolint.mdx index 6898ab9de..a4a2922eb 100644 --- a/versioned_docs/version-2.16/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/helm-k8s-parser.mdx b/versioned_docs/version-2.16/reference/subsystems/helm-k8s-parser.mdx index 55eb4eede..0ac8f1465 100644 --- a/versioned_docs/version-2.16/reference/subsystems/helm-k8s-parser.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/helm-k8s-parser.mdx @@ -1,5 +1,7 @@ --- title: helm-k8s-parser +description: | + Analyses K8S manifests rendered by Helm. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/helm-post-renderer.mdx b/versioned_docs/version-2.16/reference/subsystems/helm-post-renderer.mdx index ffd348d2f..19b37172a 100644 --- a/versioned_docs/version-2.16/reference/subsystems/helm-post-renderer.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/helm-post-renderer.mdx @@ -1,5 +1,7 @@ --- title: helm-post-renderer +description: | + Used perform modifications to the final output produced by Helm charts when they've been fully rendered. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/helm-unittest.mdx b/versioned_docs/version-2.16/reference/subsystems/helm-unittest.mdx index 2fb1aec41..1085daee9 100644 --- a/versioned_docs/version-2.16/reference/subsystems/helm-unittest.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/helm-unittest.mdx @@ -1,5 +1,7 @@ --- title: helm-unittest +description: | + BDD styled unit test framework for Kubernetes Helm charts as a Helm plugin. (https://github.com/quintush/helm-unittest) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/helm.mdx b/versioned_docs/version-2.16/reference/subsystems/helm.mdx index 6bf31c23f..f34ff025d 100644 --- a/versioned_docs/version-2.16/reference/subsystems/helm.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/ipython.mdx b/versioned_docs/version-2.16/reference/subsystems/ipython.mdx index 951ad91e8..a49dd007d 100644 --- a/versioned_docs/version-2.16/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/isort.mdx b/versioned_docs/version-2.16/reference/subsystems/isort.mdx index d49a9d3e3..021c20093 100644 --- a/versioned_docs/version-2.16/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/jarjar.mdx b/versioned_docs/version-2.16/reference/subsystems/jarjar.mdx index 56bbc8245..8b99070b8 100644 --- a/versioned_docs/version-2.16/reference/subsystems/jarjar.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/jarjar.mdx @@ -1,5 +1,7 @@ --- title: jarjar +description: | + The Jar Jar Abrams tool (https://github.com/eed3si9n/jarjar-abrams) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.16/reference/subsystems/java-infer.mdx index 9b365727f..2088e9ff2 100644 --- a/versioned_docs/version-2.16/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/javac.mdx b/versioned_docs/version-2.16/reference/subsystems/javac.mdx index 32f80db89..a7ac13086 100644 --- a/versioned_docs/version-2.16/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/junit.mdx b/versioned_docs/version-2.16/reference/subsystems/junit.mdx index 9a1b14197..7e6121a09 100644 --- a/versioned_docs/version-2.16/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/jvm.mdx b/versioned_docs/version-2.16/reference/subsystems/jvm.mdx index 800cfb402..2dbfde106 100644 --- a/versioned_docs/version-2.16/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/kotlin-infer.mdx b/versioned_docs/version-2.16/reference/subsystems/kotlin-infer.mdx index 1241c712c..89eb838c9 100644 --- a/versioned_docs/version-2.16/reference/subsystems/kotlin-infer.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/kotlin-infer.mdx @@ -1,5 +1,7 @@ --- title: kotlin-infer +description: | + Options controlling which dependencies will be inferred for Kotlin targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/kotlin.mdx b/versioned_docs/version-2.16/reference/subsystems/kotlin.mdx index 25b150315..50785c245 100644 --- a/versioned_docs/version-2.16/reference/subsystems/kotlin.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/kotlin.mdx @@ -1,5 +1,7 @@ --- title: kotlin +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/kotlinc.mdx b/versioned_docs/version-2.16/reference/subsystems/kotlinc.mdx index 428423319..3c9d68d40 100644 --- a/versioned_docs/version-2.16/reference/subsystems/kotlinc.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/kotlinc.mdx @@ -1,5 +1,7 @@ --- title: kotlinc +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.16/reference/subsystems/ktlint.mdx index 91e1b684d..e9210e035 100644 --- a/versioned_docs/version-2.16/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/ktlint.mdx @@ -1,5 +1,7 @@ --- title: ktlint +description: | + Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.16/reference/subsystems/lambdex.mdx index 73a40a611..d08633c50 100644 --- a/versioned_docs/version-2.16/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.16/reference/subsystems/mypy-protobuf.mdx index c4c2726ae..b0993d61c 100644 --- a/versioned_docs/version-2.16/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/mypy.mdx b/versioned_docs/version-2.16/reference/subsystems/mypy.mdx index 8ff641476..a081b6f79 100644 --- a/versioned_docs/version-2.16/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/nodejs.mdx b/versioned_docs/version-2.16/reference/subsystems/nodejs.mdx index 708e03b0a..3eb072b9b 100644 --- a/versioned_docs/version-2.16/reference/subsystems/nodejs.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/nodejs.mdx @@ -1,5 +1,7 @@ --- title: nodejs +description: | + The NodeJS Javascript runtime (including npm and npx). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/openapi.mdx b/versioned_docs/version-2.16/reference/subsystems/openapi.mdx index e1bf02a46..78c72dfbc 100644 --- a/versioned_docs/version-2.16/reference/subsystems/openapi.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/openapi.mdx @@ -1,5 +1,7 @@ --- title: openapi +description: | + The OpenAPI Specification (https://swagger.io/specification/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.16/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.16/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.16/reference/subsystems/pex-cli.mdx index f247d34cc..fdc0d51c7 100644 --- a/versioned_docs/version-2.16/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/pex.mdx b/versioned_docs/version-2.16/reference/subsystems/pex.mdx index 6562ee0d6..368a1dc0d 100644 --- a/versioned_docs/version-2.16/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/preamble.mdx b/versioned_docs/version-2.16/reference/subsystems/preamble.mdx index f59c85e46..f76904b26 100644 --- a/versioned_docs/version-2.16/reference/subsystems/preamble.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/preamble.mdx @@ -1,5 +1,7 @@ --- title: preamble +description: | + Formats files with a preamble, with the preamble looked up based on path. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.16/reference/subsystems/protobuf-java-grpc.mdx index d1937eed9..1806fbbb9 100644 --- a/versioned_docs/version-2.16/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/protobuf-java-grpc.mdx @@ -1,5 +1,7 @@ --- title: protobuf-java-grpc +description: | + gRPC support for Java Protobuf (https://github.com/grpc/grpc-java) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/protoc.mdx b/versioned_docs/version-2.16/reference/subsystems/protoc.mdx index 708a6481c..9552acfd0 100644 --- a/versioned_docs/version-2.16/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/pydocstyle.mdx b/versioned_docs/version-2.16/reference/subsystems/pydocstyle.mdx index 843fb48e2..4ef6b4a3d 100644 --- a/versioned_docs/version-2.16/reference/subsystems/pydocstyle.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/pydocstyle.mdx @@ -1,5 +1,7 @@ --- title: pydocstyle +description: | + A tool for checking compliance with Python docstring conventions (http://www.pydocstyle.org/en/stable/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/pylint.mdx b/versioned_docs/version-2.16/reference/subsystems/pylint.mdx index f37809a05..694d69401 100644 --- a/versioned_docs/version-2.16/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.16/reference/subsystems/pyoxidizer.mdx index a6ab24da8..c768e6a53 100644 --- a/versioned_docs/version-2.16/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/pytest.mdx b/versioned_docs/version-2.16/reference/subsystems/pytest.mdx index be5eb8539..3b5c4a4eb 100644 --- a/versioned_docs/version-2.16/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.16/reference/subsystems/python-bootstrap.mdx index e68fd4174..ed1a94a98 100644 --- a/versioned_docs/version-2.16/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.16/reference/subsystems/python-infer.mdx index 8b7cd48ea..c077a410d 100644 --- a/versioned_docs/version-2.16/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.16/reference/subsystems/python-native-code.mdx index 766ddeedb..dfdb91103 100644 --- a/versioned_docs/version-2.16/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.16/reference/subsystems/python-protobuf.mdx index 7e7bb910f..56789001f 100644 --- a/versioned_docs/version-2.16/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.16/reference/subsystems/python-repos.mdx index 29595a8d8..76450cfbf 100644 --- a/versioned_docs/version-2.16/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.16/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/versioned_docs/version-2.16/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/python.mdx b/versioned_docs/version-2.16/reference/subsystems/python.mdx index b79e0f735..f089f5794 100644 --- a/versioned_docs/version-2.16/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.16/reference/subsystems/pyupgrade.mdx index 4c8340bb4..f225bdf36 100644 --- a/versioned_docs/version-2.16/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.16/reference/subsystems/regex-lint.mdx index 34376a064..0ae838c11 100644 --- a/versioned_docs/version-2.16/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/ruff.mdx b/versioned_docs/version-2.16/reference/subsystems/ruff.mdx index 553a261d7..93daa296e 100644 --- a/versioned_docs/version-2.16/reference/subsystems/ruff.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/ruff.mdx @@ -1,5 +1,7 @@ --- title: ruff +description: | + The Ruff Python formatter (https://github.com/charliermarsh/ruff). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.16/reference/subsystems/scala-infer.mdx index e1d0849de..f8a953742 100644 --- a/versioned_docs/version-2.16/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/scala.mdx b/versioned_docs/version-2.16/reference/subsystems/scala.mdx index b55c6b2ae..8184f5acf 100644 --- a/versioned_docs/version-2.16/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/scalac.mdx b/versioned_docs/version-2.16/reference/subsystems/scalac.mdx index 93dd5914c..d2ddec7ca 100644 --- a/versioned_docs/version-2.16/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.16/reference/subsystems/scalafmt.mdx index 779bcb54a..fd4d1528d 100644 --- a/versioned_docs/version-2.16/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.16/reference/subsystems/scalapb.mdx index 07cd4b14e..d753807ad 100644 --- a/versioned_docs/version-2.16/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.16/reference/subsystems/scalatest.mdx index f57f0d150..53051970f 100644 --- a/versioned_docs/version-2.16/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/scc.mdx b/versioned_docs/version-2.16/reference/subsystems/scc.mdx index 7dbf50e1a..e78328522 100644 --- a/versioned_docs/version-2.16/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.16/reference/subsystems/setup-py-generation.mdx index 1f5e97187..5f9ca632c 100644 --- a/versioned_docs/version-2.16/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/setuptools-scm.mdx b/versioned_docs/version-2.16/reference/subsystems/setuptools-scm.mdx index 6c3afac95..2ef534e5d 100644 --- a/versioned_docs/version-2.16/reference/subsystems/setuptools-scm.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/setuptools-scm.mdx @@ -1,5 +1,7 @@ --- title: setuptools-scm +description: | + A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.16/reference/subsystems/setuptools.mdx index ef238d0dc..52fb06bde 100644 --- a/versioned_docs/version-2.16/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.16/reference/subsystems/shell-setup.mdx index bd86c0fb6..de8a06839 100644 --- a/versioned_docs/version-2.16/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/shell-test.mdx b/versioned_docs/version-2.16/reference/subsystems/shell-test.mdx index 489c11311..311238694 100644 --- a/versioned_docs/version-2.16/reference/subsystems/shell-test.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/shell-test.mdx @@ -1,5 +1,7 @@ --- title: shell-test +description: | + Options for Pants' Shell test support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.16/reference/subsystems/shellcheck.mdx index e5ed56631..a89e42098 100644 --- a/versioned_docs/version-2.16/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.16/reference/subsystems/shfmt.mdx index 9242d68fa..526d0d41c 100644 --- a/versioned_docs/version-2.16/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/shunit2.mdx b/versioned_docs/version-2.16/reference/subsystems/shunit2.mdx index f7609a51b..80a4c9b77 100644 --- a/versioned_docs/version-2.16/reference/subsystems/shunit2.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/shunit2.mdx @@ -1,5 +1,7 @@ --- title: shunit2 +description: | + shUnit2 is a xUnit framework for Bourne based shell scripts (https://github.com/kward/shunit2) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/source.mdx b/versioned_docs/version-2.16/reference/subsystems/source.mdx index a63b6afe2..410436248 100644 --- a/versioned_docs/version-2.16/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/spectral.mdx b/versioned_docs/version-2.16/reference/subsystems/spectral.mdx index d924e6c5c..6eb8c493e 100644 --- a/versioned_docs/version-2.16/reference/subsystems/spectral.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/spectral.mdx @@ -1,5 +1,7 @@ --- title: spectral +description: | + A flexible JSON/YAML linter for creating automated style guides (https://github.com/stoplightio/spectral). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/stats.mdx b/versioned_docs/version-2.16/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.16/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.16/reference/subsystems/subprocess-environment.mdx index 19aee2c9b..0961f9f79 100644 --- a/versioned_docs/version-2.16/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/terraform-fmt.mdx b/versioned_docs/version-2.16/reference/subsystems/terraform-fmt.mdx index 49bbf119b..e967d1f9c 100644 --- a/versioned_docs/version-2.16/reference/subsystems/terraform-fmt.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/terraform-hcl2-parser.mdx b/versioned_docs/version-2.16/reference/subsystems/terraform-hcl2-parser.mdx index e6b27840f..d7f315075 100644 --- a/versioned_docs/version-2.16/reference/subsystems/terraform-hcl2-parser.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/terraform-validate.mdx b/versioned_docs/version-2.16/reference/subsystems/terraform-validate.mdx index edb178a87..6cb16de11 100644 --- a/versioned_docs/version-2.16/reference/subsystems/terraform-validate.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/thrift.mdx b/versioned_docs/version-2.16/reference/subsystems/thrift.mdx index 230854701..7a691f82d 100644 --- a/versioned_docs/version-2.16/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/twine.mdx b/versioned_docs/version-2.16/reference/subsystems/twine.mdx index 03c8d5334..41a14cbc1 100644 --- a/versioned_docs/version-2.16/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPI and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/yamllint.mdx b/versioned_docs/version-2.16/reference/subsystems/yamllint.mdx index 9b3308a1e..740e4fffb 100644 --- a/versioned_docs/version-2.16/reference/subsystems/yamllint.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/yamllint.mdx @@ -1,5 +1,7 @@ --- title: yamllint +description: | + A linter for YAML files (https://yamllint.readthedocs.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/subsystems/yapf.mdx b/versioned_docs/version-2.16/reference/subsystems/yapf.mdx index 76cb92ad8..dd65391da 100644 --- a/versioned_docs/version-2.16/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.16/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.16/reference/targets/adhoc_tool.mdx b/versioned_docs/version-2.16/reference/targets/adhoc_tool.mdx index 6612a2f1b..d68467695 100644 --- a/versioned_docs/version-2.16/reference/targets/adhoc_tool.mdx +++ b/versioned_docs/version-2.16/reference/targets/adhoc_tool.mdx @@ -1,5 +1,7 @@ --- title: adhoc_tool +description: | + Execute any runnable target for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/archive.mdx b/versioned_docs/version-2.16/reference/targets/archive.mdx index b3f69629d..114cb1b42 100644 --- a/versioned_docs/version-2.16/reference/targets/archive.mdx +++ b/versioned_docs/version-2.16/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.16/reference/targets/deploy_jar.mdx index 19a2f2cec..e297dfb6f 100644 --- a/versioned_docs/version-2.16/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.16/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/docker_environment.mdx b/versioned_docs/version-2.16/reference/targets/docker_environment.mdx index 318a734bd..106ac7c53 100644 --- a/versioned_docs/version-2.16/reference/targets/docker_environment.mdx +++ b/versioned_docs/version-2.16/reference/targets/docker_environment.mdx @@ -1,5 +1,7 @@ --- title: docker_environment +description: | + Configuration of a Docker environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/docker_image.mdx b/versioned_docs/version-2.16/reference/targets/docker_image.mdx index a56c83397..33bd90272 100644 --- a/versioned_docs/version-2.16/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.16/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/experimental_test_shell_command.mdx b/versioned_docs/version-2.16/reference/targets/experimental_test_shell_command.mdx index 358e443a9..7395e58b1 100644 --- a/versioned_docs/version-2.16/reference/targets/experimental_test_shell_command.mdx +++ b/versioned_docs/version-2.16/reference/targets/experimental_test_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_test_shell_command +description: | + Run a script as a test via the `test` goal, with all dependencies packaged/copied available in the chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_go_package_sources.mdx b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_go_package_sources.mdx index 0630639a4..b12d53c8d 100644 --- a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_go_package_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_go_package_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_go_package_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `GoPackageSourcesField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_java_sources.mdx b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_java_sources.mdx index ff3e04681..c3c6f8c4d 100644 --- a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_java_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_java_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_java_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `JavaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_kotlin_sources.mdx b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_kotlin_sources.mdx index bae3428a7..a17b55a26 100644 --- a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_kotlin_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_kotlin_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `KotlinSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_python_sources.mdx b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_python_sources.mdx index 5751ec09f..169ffa6c2 100644 --- a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_python_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_python_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_python_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `PythonSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_resources.mdx b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_resources.mdx index e7518c7f5..1a28ef627 100644 --- a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_resources.mdx +++ b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_resources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_resources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ResourceSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_scala_sources.mdx b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_scala_sources.mdx index 5548c481b..d08d758a2 100644 --- a/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_scala_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/experimental_wrap_as_scala_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_scala_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ScalaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/file.mdx b/versioned_docs/version-2.16/reference/targets/file.mdx index 6e2c22b82..4a78840eb 100644 --- a/versioned_docs/version-2.16/reference/targets/file.mdx +++ b/versioned_docs/version-2.16/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/files.mdx b/versioned_docs/version-2.16/reference/targets/files.mdx index 88be067b6..b551e6e80 100644 --- a/versioned_docs/version-2.16/reference/targets/files.mdx +++ b/versioned_docs/version-2.16/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/go_binary.mdx b/versioned_docs/version-2.16/reference/targets/go_binary.mdx index e1a85a7a6..3762d6c9d 100644 --- a/versioned_docs/version-2.16/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.16/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/go_mod.mdx b/versioned_docs/version-2.16/reference/targets/go_mod.mdx index a0cfd6173..eddaa16fd 100644 --- a/versioned_docs/version-2.16/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.16/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/go_package.mdx b/versioned_docs/version-2.16/reference/targets/go_package.mdx index 61338159d..c3a14222d 100644 --- a/versioned_docs/version-2.16/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.16/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.16/reference/targets/go_third_party_package.mdx index baea6e11f..df37493b3 100644 --- a/versioned_docs/version-2.16/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.16/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/helm_artifact.mdx b/versioned_docs/version-2.16/reference/targets/helm_artifact.mdx index df2c66974..3278b9c18 100644 --- a/versioned_docs/version-2.16/reference/targets/helm_artifact.mdx +++ b/versioned_docs/version-2.16/reference/targets/helm_artifact.mdx @@ -1,5 +1,7 @@ --- title: helm_artifact +description: | + A third party Helm artifact. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/helm_chart.mdx b/versioned_docs/version-2.16/reference/targets/helm_chart.mdx index fdce24bc6..5a9363713 100644 --- a/versioned_docs/version-2.16/reference/targets/helm_chart.mdx +++ b/versioned_docs/version-2.16/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/helm_deployment.mdx b/versioned_docs/version-2.16/reference/targets/helm_deployment.mdx index 4878fb7f4..4b1672858 100644 --- a/versioned_docs/version-2.16/reference/targets/helm_deployment.mdx +++ b/versioned_docs/version-2.16/reference/targets/helm_deployment.mdx @@ -1,5 +1,7 @@ --- title: helm_deployment +description: | + A Helm chart deployment. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/helm_unittest_test.mdx b/versioned_docs/version-2.16/reference/targets/helm_unittest_test.mdx index 2b690bc71..e8d726c0f 100644 --- a/versioned_docs/version-2.16/reference/targets/helm_unittest_test.mdx +++ b/versioned_docs/version-2.16/reference/targets/helm_unittest_test.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_test +description: | + A single helm-unittest suite file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/helm_unittest_tests.mdx b/versioned_docs/version-2.16/reference/targets/helm_unittest_tests.mdx index 8a05c6a3e..7bf554abe 100644 --- a/versioned_docs/version-2.16/reference/targets/helm_unittest_tests.mdx +++ b/versioned_docs/version-2.16/reference/targets/helm_unittest_tests.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_tests +description: | + Generates a `helm_unittest_test` target per each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/java_source.mdx b/versioned_docs/version-2.16/reference/targets/java_source.mdx index 8fef2f796..8d69aec4e 100644 --- a/versioned_docs/version-2.16/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.16/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/java_sources.mdx b/versioned_docs/version-2.16/reference/targets/java_sources.mdx index ccad52d04..ed014227b 100644 --- a/versioned_docs/version-2.16/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/junit_test.mdx b/versioned_docs/version-2.16/reference/targets/junit_test.mdx index 2e7edfbb6..66a53f638 100644 --- a/versioned_docs/version-2.16/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.16/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/junit_tests.mdx b/versioned_docs/version-2.16/reference/targets/junit_tests.mdx index cf0c36400..5e5c4d1c0 100644 --- a/versioned_docs/version-2.16/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.16/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.16/reference/targets/jvm_artifact.mdx index 7364dac42..40c94d056 100644 --- a/versioned_docs/version-2.16/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.16/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/jvm_war.mdx b/versioned_docs/version-2.16/reference/targets/jvm_war.mdx index 7cc0571b7..e5f881a1f 100644 --- a/versioned_docs/version-2.16/reference/targets/jvm_war.mdx +++ b/versioned_docs/version-2.16/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/kotlin_junit_test.mdx b/versioned_docs/version-2.16/reference/targets/kotlin_junit_test.mdx index 8a860b1a2..5d8291a90 100644 --- a/versioned_docs/version-2.16/reference/targets/kotlin_junit_test.mdx +++ b/versioned_docs/version-2.16/reference/targets/kotlin_junit_test.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_test +description: | + A single Kotlin test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/kotlin_junit_tests.mdx b/versioned_docs/version-2.16/reference/targets/kotlin_junit_tests.mdx index a2f9ec28e..b89d6c236 100644 --- a/versioned_docs/version-2.16/reference/targets/kotlin_junit_tests.mdx +++ b/versioned_docs/version-2.16/reference/targets/kotlin_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_tests +description: | + Generate a `kotlin_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/kotlin_source.mdx b/versioned_docs/version-2.16/reference/targets/kotlin_source.mdx index ec2ae18c3..4d8a91216 100644 --- a/versioned_docs/version-2.16/reference/targets/kotlin_source.mdx +++ b/versioned_docs/version-2.16/reference/targets/kotlin_source.mdx @@ -1,5 +1,7 @@ --- title: kotlin_source +description: | + A single Kotlin source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/kotlin_sources.mdx b/versioned_docs/version-2.16/reference/targets/kotlin_sources.mdx index feac16fbf..5515ffff6 100644 --- a/versioned_docs/version-2.16/reference/targets/kotlin_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: kotlin_sources +description: | + Generate a `kotlin_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/kotlinc_plugin.mdx b/versioned_docs/version-2.16/reference/targets/kotlinc_plugin.mdx index c84b49d86..320e3dd2e 100644 --- a/versioned_docs/version-2.16/reference/targets/kotlinc_plugin.mdx +++ b/versioned_docs/version-2.16/reference/targets/kotlinc_plugin.mdx @@ -1,5 +1,7 @@ --- title: kotlinc_plugin +description: | + A plugin for `kotlinc`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/local_environment.mdx b/versioned_docs/version-2.16/reference/targets/local_environment.mdx index 6c1ac7d2a..9afdac23b 100644 --- a/versioned_docs/version-2.16/reference/targets/local_environment.mdx +++ b/versioned_docs/version-2.16/reference/targets/local_environment.mdx @@ -1,5 +1,7 @@ --- title: local_environment +description: | + Configuration of a local execution environment for specific platforms. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/openapi_document.mdx b/versioned_docs/version-2.16/reference/targets/openapi_document.mdx index e6ad1a908..8db4e8797 100644 --- a/versioned_docs/version-2.16/reference/targets/openapi_document.mdx +++ b/versioned_docs/version-2.16/reference/targets/openapi_document.mdx @@ -1,5 +1,7 @@ --- title: openapi_document +description: | + A single OpenAPI document file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/openapi_documents.mdx b/versioned_docs/version-2.16/reference/targets/openapi_documents.mdx index 33e814a04..d58c75cdc 100644 --- a/versioned_docs/version-2.16/reference/targets/openapi_documents.mdx +++ b/versioned_docs/version-2.16/reference/targets/openapi_documents.mdx @@ -1,5 +1,7 @@ --- title: openapi_documents +description: | + Generate an `openapi_document` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/openapi_source.mdx b/versioned_docs/version-2.16/reference/targets/openapi_source.mdx index 9ec4b4d20..5925b58a9 100644 --- a/versioned_docs/version-2.16/reference/targets/openapi_source.mdx +++ b/versioned_docs/version-2.16/reference/targets/openapi_source.mdx @@ -1,5 +1,7 @@ --- title: openapi_source +description: | + A single OpenAPI source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/openapi_sources.mdx b/versioned_docs/version-2.16/reference/targets/openapi_sources.mdx index 11348f03c..24390d417 100644 --- a/versioned_docs/version-2.16/reference/targets/openapi_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/openapi_sources.mdx @@ -1,5 +1,7 @@ --- title: openapi_sources +description: | + Generate an `openapi_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.16/reference/targets/pants_requirements.mdx index 8c1839d5e..425fd970b 100644 --- a/versioned_docs/version-2.16/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.16/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.16/reference/targets/pex_binaries.mdx index 2ba3b0c70..0e3c50b51 100644 --- a/versioned_docs/version-2.16/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.16/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/pex_binary.mdx b/versioned_docs/version-2.16/reference/targets/pex_binary.mdx index 2a2fbce37..bbf6c210d 100644 --- a/versioned_docs/version-2.16/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.16/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.16/reference/targets/pipenv_requirements.mdx index 7a90d868e..6a9ee9672 100644 --- a/versioned_docs/version-2.16/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.16/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.16/reference/targets/poetry_requirements.mdx index 9903211c1..08a32c8b5 100644 --- a/versioned_docs/version-2.16/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.16/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry pyproject.toml. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.16/reference/targets/protobuf_source.mdx index bf3739f4a..9edbe8a6b 100644 --- a/versioned_docs/version-2.16/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.16/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.16/reference/targets/protobuf_sources.mdx index 1e11ade8a..e225b63b1 100644 --- a/versioned_docs/version-2.16/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.16/reference/targets/pyoxidizer_binary.mdx index 8e0f38142..81042eb48 100644 --- a/versioned_docs/version-2.16/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.16/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.16/reference/targets/python_awslambda.mdx index 3dd2ae2d2..7bea0fd94 100644 --- a/versioned_docs/version-2.16/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_distribution.mdx b/versioned_docs/version-2.16/reference/targets/python_distribution.mdx index 14923edcb..ac2f96276 100644 --- a/versioned_docs/version-2.16/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.16/reference/targets/python_google_cloud_function.mdx index f2ce6320a..4c60ab771 100644 --- a/versioned_docs/version-2.16/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_requirement.mdx b/versioned_docs/version-2.16/reference/targets/python_requirement.mdx index 35ce8965d..e7ad5c648 100644 --- a/versioned_docs/version-2.16/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_requirements.mdx b/versioned_docs/version-2.16/reference/targets/python_requirements.mdx index 41a91aa43..0eee2de90 100644 --- a/versioned_docs/version-2.16/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style or PEP 621 compliant pyproject.toml file. The choice of parser for the `source` field is determined by the file name. If the `source` field ends with `pyproject.toml`, then the file is assumed to be a PEP 621 compliant file. Any other file name uses the requirements.txt-style parser. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_source.mdx b/versioned_docs/version-2.16/reference/targets/python_source.mdx index bbdf93def..33b60a9ca 100644 --- a/versioned_docs/version-2.16/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_sources.mdx b/versioned_docs/version-2.16/reference/targets/python_sources.mdx index 2ea5e6389..67623d41d 100644 --- a/versioned_docs/version-2.16/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_test.mdx b/versioned_docs/version-2.16/reference/targets/python_test.mdx index c5537ab92..6f91f83b2 100644 --- a/versioned_docs/version-2.16/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.16/reference/targets/python_test_utils.mdx index 5eb86e054..8a2878da8 100644 --- a/versioned_docs/version-2.16/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/python_tests.mdx b/versioned_docs/version-2.16/reference/targets/python_tests.mdx index 8a390d504..26d567cc0 100644 --- a/versioned_docs/version-2.16/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.16/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/relocated_files.mdx b/versioned_docs/version-2.16/reference/targets/relocated_files.mdx index 346339e69..9efc94ea5 100644 --- a/versioned_docs/version-2.16/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.16/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/remote_environment.mdx b/versioned_docs/version-2.16/reference/targets/remote_environment.mdx index 17b38233b..822d31f42 100644 --- a/versioned_docs/version-2.16/reference/targets/remote_environment.mdx +++ b/versioned_docs/version-2.16/reference/targets/remote_environment.mdx @@ -1,5 +1,7 @@ --- title: remote_environment +description: | + Configuration of a remote execution environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/resource.mdx b/versioned_docs/version-2.16/reference/targets/resource.mdx index ff726ed52..d08841a7c 100644 --- a/versioned_docs/version-2.16/reference/targets/resource.mdx +++ b/versioned_docs/version-2.16/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/resources.mdx b/versioned_docs/version-2.16/reference/targets/resources.mdx index efe77d150..f8dbd3c9c 100644 --- a/versioned_docs/version-2.16/reference/targets/resources.mdx +++ b/versioned_docs/version-2.16/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/run_shell_command.mdx b/versioned_docs/version-2.16/reference/targets/run_shell_command.mdx index e1e36c6e7..2bb4368a8 100644 --- a/versioned_docs/version-2.16/reference/targets/run_shell_command.mdx +++ b/versioned_docs/version-2.16/reference/targets/run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.16/reference/targets/scala_junit_test.mdx index 5aad958d7..76f0e7dff 100644 --- a/versioned_docs/version-2.16/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.16/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.16/reference/targets/scala_junit_tests.mdx index 8bd5a7976..5ee574c82 100644 --- a/versioned_docs/version-2.16/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.16/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/scala_source.mdx b/versioned_docs/version-2.16/reference/targets/scala_source.mdx index 4aef57641..331217914 100644 --- a/versioned_docs/version-2.16/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.16/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/scala_sources.mdx b/versioned_docs/version-2.16/reference/targets/scala_sources.mdx index 28229364c..1ecf81c40 100644 --- a/versioned_docs/version-2.16/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.16/reference/targets/scalac_plugin.mdx index b67cbac68..0763f19da 100644 --- a/versioned_docs/version-2.16/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.16/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.16/reference/targets/scalatest_test.mdx index 308e060d3..e03282a4c 100644 --- a/versioned_docs/version-2.16/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.16/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.16/reference/targets/scalatest_tests.mdx index 9462dd26f..b6c85e163 100644 --- a/versioned_docs/version-2.16/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.16/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching ('*Spec.scala', '*Suite.scala')). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/shell_command.mdx b/versioned_docs/version-2.16/reference/targets/shell_command.mdx index 323774678..6fd994418 100644 --- a/versioned_docs/version-2.16/reference/targets/shell_command.mdx +++ b/versioned_docs/version-2.16/reference/targets/shell_command.mdx @@ -1,5 +1,7 @@ --- title: shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/shell_source.mdx b/versioned_docs/version-2.16/reference/targets/shell_source.mdx index 78a493a6c..83c2ecd4b 100644 --- a/versioned_docs/version-2.16/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.16/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/shell_sources.mdx b/versioned_docs/version-2.16/reference/targets/shell_sources.mdx index c1ab5780e..1b7808aaf 100644 --- a/versioned_docs/version-2.16/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.16/reference/targets/shunit2_test.mdx index 1541552c3..ca62d2ca8 100644 --- a/versioned_docs/version-2.16/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.16/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.16/reference/targets/shunit2_tests.mdx index 504634bf5..9ee942889 100644 --- a/versioned_docs/version-2.16/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.16/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/system_binary.mdx b/versioned_docs/version-2.16/reference/targets/system_binary.mdx index d7bd775a0..017c61020 100644 --- a/versioned_docs/version-2.16/reference/targets/system_binary.mdx +++ b/versioned_docs/version-2.16/reference/targets/system_binary.mdx @@ -1,5 +1,7 @@ --- title: system_binary +description: | + A system binary that can be run with `pants run` or consumed by `adhoc_tool`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/target.mdx b/versioned_docs/version-2.16/reference/targets/target.mdx index 581ce3561..0d7e5b62a 100644 --- a/versioned_docs/version-2.16/reference/targets/target.mdx +++ b/versioned_docs/version-2.16/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/terraform_module.mdx b/versioned_docs/version-2.16/reference/targets/terraform_module.mdx index c910536e8..d289305ab 100644 --- a/versioned_docs/version-2.16/reference/targets/terraform_module.mdx +++ b/versioned_docs/version-2.16/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/thrift_source.mdx b/versioned_docs/version-2.16/reference/targets/thrift_source.mdx index d4ac0fc26..5b4944871 100644 --- a/versioned_docs/version-2.16/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.16/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.16/reference/targets/thrift_sources.mdx index 4ca3bc64c..6712d0eee 100644 --- a/versioned_docs/version-2.16/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.16/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.16/reference/targets/vcs_version.mdx b/versioned_docs/version-2.16/reference/targets/vcs_version.mdx index ec23fdece..08ef5b024 100644 --- a/versioned_docs/version-2.16/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.16/reference/targets/vcs_version.mdx @@ -1,5 +1,7 @@ --- title: vcs_version +description: | + Generates a version string from VCS state. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/global-options.mdx b/versioned_docs/version-2.17/reference/global-options.mdx index db7910db5..0ae130ed0 100644 --- a/versioned_docs/version-2.17/reference/global-options.mdx +++ b/versioned_docs/version-2.17/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/check.mdx b/versioned_docs/version-2.17/reference/goals/check.mdx index 055b4584b..d2b292a1c 100644 --- a/versioned_docs/version-2.17/reference/goals/check.mdx +++ b/versioned_docs/version-2.17/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/count-loc.mdx b/versioned_docs/version-2.17/reference/goals/count-loc.mdx index fcd1ded48..1a9c711fe 100644 --- a/versioned_docs/version-2.17/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.17/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/dependees.mdx b/versioned_docs/version-2.17/reference/goals/dependees.mdx index c8d158961..4033c80d2 100644 --- a/versioned_docs/version-2.17/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.17/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/dependencies.mdx b/versioned_docs/version-2.17/reference/goals/dependencies.mdx index eecf7ea2a..4d03fb731 100644 --- a/versioned_docs/version-2.17/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.17/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/dependents.mdx b/versioned_docs/version-2.17/reference/goals/dependents.mdx index d8f395668..6727ab393 100644 --- a/versioned_docs/version-2.17/reference/goals/dependents.mdx +++ b/versioned_docs/version-2.17/reference/goals/dependents.mdx @@ -1,5 +1,7 @@ --- title: dependents +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.17/reference/goals/experimental-bsp.mdx index 6ffa7f417..fcc748c92 100644 --- a/versioned_docs/version-2.17/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.17/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/experimental-deploy.mdx b/versioned_docs/version-2.17/reference/goals/experimental-deploy.mdx index cedddbdf4..f437c6091 100644 --- a/versioned_docs/version-2.17/reference/goals/experimental-deploy.mdx +++ b/versioned_docs/version-2.17/reference/goals/experimental-deploy.mdx @@ -1,5 +1,7 @@ --- title: experimental-deploy +description: | + Perform a deployment process. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/experimental-explorer.mdx b/versioned_docs/version-2.17/reference/goals/experimental-explorer.mdx index eb5e42352..7df90e7dc 100644 --- a/versioned_docs/version-2.17/reference/goals/experimental-explorer.mdx +++ b/versioned_docs/version-2.17/reference/goals/experimental-explorer.mdx @@ -1,5 +1,7 @@ --- title: experimental-explorer +description: | + Run the Pants Explorer Web UI server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/export-codegen.mdx b/versioned_docs/version-2.17/reference/goals/export-codegen.mdx index 08f5cb08d..5ba91e387 100644 --- a/versioned_docs/version-2.17/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.17/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/export.mdx b/versioned_docs/version-2.17/reference/goals/export.mdx index 7f242289f..86a8edf19 100644 --- a/versioned_docs/version-2.17/reference/goals/export.mdx +++ b/versioned_docs/version-2.17/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/filedeps.mdx b/versioned_docs/version-2.17/reference/goals/filedeps.mdx index fadeb17a0..ea3763879 100644 --- a/versioned_docs/version-2.17/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.17/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/fix.mdx b/versioned_docs/version-2.17/reference/goals/fix.mdx index a685b2f1f..13f929340 100644 --- a/versioned_docs/version-2.17/reference/goals/fix.mdx +++ b/versioned_docs/version-2.17/reference/goals/fix.mdx @@ -1,5 +1,7 @@ --- title: fix +description: | + Autofix source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/fmt.mdx b/versioned_docs/version-2.17/reference/goals/fmt.mdx index 240a8c110..5a36ff102 100644 --- a/versioned_docs/version-2.17/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.17/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.17/reference/goals/generate-lockfiles.mdx index 174338416..08068b65d 100644 --- a/versioned_docs/version-2.17/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.17/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/go-generate.mdx b/versioned_docs/version-2.17/reference/goals/go-generate.mdx index 484728cb1..6bc7d2863 100644 --- a/versioned_docs/version-2.17/reference/goals/go-generate.mdx +++ b/versioned_docs/version-2.17/reference/goals/go-generate.mdx @@ -1,5 +1,7 @@ --- title: go-generate +description: | + Run each command in a package described by a `//go:generate` directive. This is equivalent to running `go generate` on a Go package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/help-advanced.mdx b/versioned_docs/version-2.17/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.17/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.17/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/help-all.mdx b/versioned_docs/version-2.17/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.17/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.17/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/help.mdx b/versioned_docs/version-2.17/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.17/reference/goals/help.mdx +++ b/versioned_docs/version-2.17/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/lint.mdx b/versioned_docs/version-2.17/reference/goals/lint.mdx index 3c193f2dd..8173b27bf 100644 --- a/versioned_docs/version-2.17/reference/goals/lint.mdx +++ b/versioned_docs/version-2.17/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run linters/formatters/fixers in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/list.mdx b/versioned_docs/version-2.17/reference/goals/list.mdx index 78d49bb55..bc858f973 100644 --- a/versioned_docs/version-2.17/reference/goals/list.mdx +++ b/versioned_docs/version-2.17/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/package.mdx b/versioned_docs/version-2.17/reference/goals/package.mdx index 357be63d3..e6cb234d7 100644 --- a/versioned_docs/version-2.17/reference/goals/package.mdx +++ b/versioned_docs/version-2.17/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/paths.mdx b/versioned_docs/version-2.17/reference/goals/paths.mdx index fb2ee3e5f..3aaeab3e9 100644 --- a/versioned_docs/version-2.17/reference/goals/paths.mdx +++ b/versioned_docs/version-2.17/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/peek.mdx b/versioned_docs/version-2.17/reference/goals/peek.mdx index f42185cf3..4c54e6307 100644 --- a/versioned_docs/version-2.17/reference/goals/peek.mdx +++ b/versioned_docs/version-2.17/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/publish.mdx b/versioned_docs/version-2.17/reference/goals/publish.mdx index b6e9c59c8..2a90b4bd6 100644 --- a/versioned_docs/version-2.17/reference/goals/publish.mdx +++ b/versioned_docs/version-2.17/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/py-constraints.mdx b/versioned_docs/version-2.17/reference/goals/py-constraints.mdx index 21a5bf3a8..7c779befd 100644 --- a/versioned_docs/version-2.17/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.17/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/python-dump-source-analysis.mdx b/versioned_docs/version-2.17/reference/goals/python-dump-source-analysis.mdx index 935e0c1f4..55b086047 100644 --- a/versioned_docs/version-2.17/reference/goals/python-dump-source-analysis.mdx +++ b/versioned_docs/version-2.17/reference/goals/python-dump-source-analysis.mdx @@ -1,5 +1,7 @@ --- title: python-dump-source-analysis +description: | + Dump source analysis for python_source targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/repl.mdx b/versioned_docs/version-2.17/reference/goals/repl.mdx index 68db5eacc..5cb31f80d 100644 --- a/versioned_docs/version-2.17/reference/goals/repl.mdx +++ b/versioned_docs/version-2.17/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/roots.mdx b/versioned_docs/version-2.17/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.17/reference/goals/roots.mdx +++ b/versioned_docs/version-2.17/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/run.mdx b/versioned_docs/version-2.17/reference/goals/run.mdx index 4a26d2e66..0a3c0375e 100644 --- a/versioned_docs/version-2.17/reference/goals/run.mdx +++ b/versioned_docs/version-2.17/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/tailor.mdx b/versioned_docs/version-2.17/reference/goals/tailor.mdx index fc1321e99..6b595e8ca 100644 --- a/versioned_docs/version-2.17/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.17/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/test.mdx b/versioned_docs/version-2.17/reference/goals/test.mdx index 14c868f49..e3b85aa71 100644 --- a/versioned_docs/version-2.17/reference/goals/test.mdx +++ b/versioned_docs/version-2.17/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/update-build-files.mdx b/versioned_docs/version-2.17/reference/goals/update-build-files.mdx index 5fe027c04..a94fd9ecd 100644 --- a/versioned_docs/version-2.17/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.17/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/goals/version.mdx b/versioned_docs/version-2.17/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.17/reference/goals/version.mdx +++ b/versioned_docs/version-2.17/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/add-trailing-comma.mdx b/versioned_docs/version-2.17/reference/subsystems/add-trailing-comma.mdx index 7b1a4fc23..7970caab1 100644 --- a/versioned_docs/version-2.17/reference/subsystems/add-trailing-comma.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/add-trailing-comma.mdx @@ -1,5 +1,7 @@ --- title: add-trailing-comma +description: | + The add-trailing-comma Python code formatter (https://github.com/asottile/add-trailing-comma). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.17/reference/subsystems/anonymous-telemetry.mdx index 367ea08cf..4e44d636e 100644 --- a/versioned_docs/version-2.17/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.17/reference/subsystems/apache-thrift.mdx index 8cd006a9a..ebd400bea 100644 --- a/versioned_docs/version-2.17/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.17/reference/subsystems/autoflake.mdx index 527cadef4..fc17b8a38 100644 --- a/versioned_docs/version-2.17/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/bandit.mdx b/versioned_docs/version-2.17/reference/subsystems/bandit.mdx index 404b8709b..9400cfdb1 100644 --- a/versioned_docs/version-2.17/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/black.mdx b/versioned_docs/version-2.17/reference/subsystems/black.mdx index 9c8674457..c4592e524 100644 --- a/versioned_docs/version-2.17/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/buf.mdx b/versioned_docs/version-2.17/reference/subsystems/buf.mdx index f42db6eaf..7d392ba37 100644 --- a/versioned_docs/version-2.17/reference/subsystems/buf.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/build-deprecations-fixer.mdx b/versioned_docs/version-2.17/reference/subsystems/build-deprecations-fixer.mdx index 657c853b8..4d775caf0 100644 --- a/versioned_docs/version-2.17/reference/subsystems/build-deprecations-fixer.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/build-deprecations-fixer.mdx @@ -1,5 +1,7 @@ --- title: build-deprecations-fixer +description: | + A tool/plugin for fixing BUILD file deprecations (where possible). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/buildifier.mdx b/versioned_docs/version-2.17/reference/subsystems/buildifier.mdx index a56ea75ed..8cb2c3bec 100644 --- a/versioned_docs/version-2.17/reference/subsystems/buildifier.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/buildifier.mdx @@ -1,5 +1,7 @@ --- title: buildifier +description: | + Buildifier is a tool for formatting BUILD files with a standard convention. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/changed.mdx b/versioned_docs/version-2.17/reference/subsystems/changed.mdx index ac3981b40..adb1c08c7 100644 --- a/versioned_docs/version-2.17/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/cli.mdx b/versioned_docs/version-2.17/reference/subsystems/cli.mdx index 7a12ca8ca..c1d3d782d 100644 --- a/versioned_docs/version-2.17/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/coursier.mdx b/versioned_docs/version-2.17/reference/subsystems/coursier.mdx index 43a67aa7d..cb759e042 100644 --- a/versioned_docs/version-2.17/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. (https://get-coursier.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.17/reference/subsystems/coverage-py.mdx index 4eaa2269d..2a0d89b40 100644 --- a/versioned_docs/version-2.17/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/debug-adapter.mdx b/versioned_docs/version-2.17/reference/subsystems/debug-adapter.mdx index d15f05658..655c51060 100644 --- a/versioned_docs/version-2.17/reference/subsystems/debug-adapter.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/debug-adapter.mdx @@ -1,5 +1,7 @@ --- title: debug-adapter +description: | + Options used to configure and launch a Debug Adapter server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/debugpy.mdx b/versioned_docs/version-2.17/reference/subsystems/debugpy.mdx index 57c063abe..1b00067d0 100644 --- a/versioned_docs/version-2.17/reference/subsystems/debugpy.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/debugpy.mdx @@ -1,5 +1,7 @@ --- title: debugpy +description: | + An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.17/reference/subsystems/docformatter.mdx index 9d812ab88..40199b0bd 100644 --- a/versioned_docs/version-2.17/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/docker.mdx b/versioned_docs/version-2.17/reference/subsystems/docker.mdx index efd39df2d..6405fef80 100644 --- a/versioned_docs/version-2.17/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.17/reference/subsystems/dockerfile-parser.mdx index 4cb5dd016..1a416135b 100644 --- a/versioned_docs/version-2.17/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/download-terraform.mdx b/versioned_docs/version-2.17/reference/subsystems/download-terraform.mdx index 0892e0116..bef6e845a 100644 --- a/versioned_docs/version-2.17/reference/subsystems/download-terraform.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/environments-preview.mdx b/versioned_docs/version-2.17/reference/subsystems/environments-preview.mdx index 780bc8363..8231798c1 100644 --- a/versioned_docs/version-2.17/reference/subsystems/environments-preview.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/environments-preview.mdx @@ -1,5 +1,7 @@ --- title: environments-preview +description: | + A highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/filter.mdx b/versioned_docs/version-2.17/reference/subsystems/filter.mdx index 2a6c4cef6..490732a64 100644 --- a/versioned_docs/version-2.17/reference/subsystems/filter.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/flake8.mdx b/versioned_docs/version-2.17/reference/subsystems/flake8.mdx index 2e8da759f..579e991b8 100644 --- a/versioned_docs/version-2.17/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/go-test.mdx b/versioned_docs/version-2.17/reference/subsystems/go-test.mdx index fc6b89a6e..79d1494c5 100644 --- a/versioned_docs/version-2.17/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.17/reference/subsystems/gofmt.mdx index 83a3eb9a5..e54bcdc75 100644 --- a/versioned_docs/version-2.17/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/golang.mdx b/versioned_docs/version-2.17/reference/subsystems/golang.mdx index 2567b6873..58618cdc2 100644 --- a/versioned_docs/version-2.17/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.17/reference/subsystems/google-java-format.mdx index eecc8b6bd..8ee11f9f4 100644 --- a/versioned_docs/version-2.17/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.17/reference/subsystems/grpc-python-plugin.mdx index 9950ee5a2..7556da390 100644 --- a/versioned_docs/version-2.17/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.17/reference/subsystems/hadolint.mdx index fb316ad5f..1157ff7fe 100644 --- a/versioned_docs/version-2.17/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/helm-k8s-parser.mdx b/versioned_docs/version-2.17/reference/subsystems/helm-k8s-parser.mdx index 90705209f..2ca4ca5c0 100644 --- a/versioned_docs/version-2.17/reference/subsystems/helm-k8s-parser.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/helm-k8s-parser.mdx @@ -1,5 +1,7 @@ --- title: helm-k8s-parser +description: | + Analyses K8S manifests rendered by Helm. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/helm-post-renderer.mdx b/versioned_docs/version-2.17/reference/subsystems/helm-post-renderer.mdx index 060dd573a..e9d296915 100644 --- a/versioned_docs/version-2.17/reference/subsystems/helm-post-renderer.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/helm-post-renderer.mdx @@ -1,5 +1,7 @@ --- title: helm-post-renderer +description: | + Used perform modifications to the final output produced by Helm charts when they've been fully rendered. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/helm-unittest.mdx b/versioned_docs/version-2.17/reference/subsystems/helm-unittest.mdx index ec54dc934..a6a04f848 100644 --- a/versioned_docs/version-2.17/reference/subsystems/helm-unittest.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/helm-unittest.mdx @@ -1,5 +1,7 @@ --- title: helm-unittest +description: | + BDD styled unit test framework for Kubernetes Helm charts as a Helm plugin. (https://github.com/quintush/helm-unittest) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/helm.mdx b/versioned_docs/version-2.17/reference/subsystems/helm.mdx index 4a116a4e3..100544bff 100644 --- a/versioned_docs/version-2.17/reference/subsystems/helm.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/ipython.mdx b/versioned_docs/version-2.17/reference/subsystems/ipython.mdx index 38de4ee33..5a5331165 100644 --- a/versioned_docs/version-2.17/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/isort.mdx b/versioned_docs/version-2.17/reference/subsystems/isort.mdx index cd2b7c1e9..2250fb019 100644 --- a/versioned_docs/version-2.17/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/jarjar.mdx b/versioned_docs/version-2.17/reference/subsystems/jarjar.mdx index adc0af622..5bfff71fb 100644 --- a/versioned_docs/version-2.17/reference/subsystems/jarjar.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/jarjar.mdx @@ -1,5 +1,7 @@ --- title: jarjar +description: | + The Jar Jar Abrams tool (https://github.com/eed3si9n/jarjar-abrams) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.17/reference/subsystems/java-infer.mdx index 9b365727f..2088e9ff2 100644 --- a/versioned_docs/version-2.17/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/javac.mdx b/versioned_docs/version-2.17/reference/subsystems/javac.mdx index 32f80db89..a7ac13086 100644 --- a/versioned_docs/version-2.17/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/junit.mdx b/versioned_docs/version-2.17/reference/subsystems/junit.mdx index 741e2fb69..49a965aad 100644 --- a/versioned_docs/version-2.17/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/jvm.mdx b/versioned_docs/version-2.17/reference/subsystems/jvm.mdx index 800cfb402..2dbfde106 100644 --- a/versioned_docs/version-2.17/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/kotlin-infer.mdx b/versioned_docs/version-2.17/reference/subsystems/kotlin-infer.mdx index 1241c712c..89eb838c9 100644 --- a/versioned_docs/version-2.17/reference/subsystems/kotlin-infer.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/kotlin-infer.mdx @@ -1,5 +1,7 @@ --- title: kotlin-infer +description: | + Options controlling which dependencies will be inferred for Kotlin targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/kotlin.mdx b/versioned_docs/version-2.17/reference/subsystems/kotlin.mdx index 25b150315..50785c245 100644 --- a/versioned_docs/version-2.17/reference/subsystems/kotlin.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/kotlin.mdx @@ -1,5 +1,7 @@ --- title: kotlin +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/kotlinc.mdx b/versioned_docs/version-2.17/reference/subsystems/kotlinc.mdx index 428423319..3c9d68d40 100644 --- a/versioned_docs/version-2.17/reference/subsystems/kotlinc.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/kotlinc.mdx @@ -1,5 +1,7 @@ --- title: kotlinc +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.17/reference/subsystems/ktlint.mdx index a7364d1c6..9b2b4e736 100644 --- a/versioned_docs/version-2.17/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/ktlint.mdx @@ -1,5 +1,7 @@ --- title: ktlint +description: | + Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.17/reference/subsystems/lambdex.mdx index 2a9c1df83..87b3da8b2 100644 --- a/versioned_docs/version-2.17/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.17/reference/subsystems/mypy-protobuf.mdx index 02a11a59a..4407ca9bc 100644 --- a/versioned_docs/version-2.17/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/mypy.mdx b/versioned_docs/version-2.17/reference/subsystems/mypy.mdx index d88e7300b..b1529f920 100644 --- a/versioned_docs/version-2.17/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/nodejs.mdx b/versioned_docs/version-2.17/reference/subsystems/nodejs.mdx index 54b0b3c87..d704c543e 100644 --- a/versioned_docs/version-2.17/reference/subsystems/nodejs.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/nodejs.mdx @@ -1,5 +1,7 @@ --- title: nodejs +description: | + The Node.js Javascript runtime (including Corepack). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/openapi.mdx b/versioned_docs/version-2.17/reference/subsystems/openapi.mdx index e1bf02a46..78c72dfbc 100644 --- a/versioned_docs/version-2.17/reference/subsystems/openapi.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/openapi.mdx @@ -1,5 +1,7 @@ --- title: openapi +description: | + The OpenAPI Specification (https://swagger.io/specification/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.17/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.17/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.17/reference/subsystems/pex-cli.mdx index 1f99b0e96..5770d4bff 100644 --- a/versioned_docs/version-2.17/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/pex.mdx b/versioned_docs/version-2.17/reference/subsystems/pex.mdx index 6562ee0d6..368a1dc0d 100644 --- a/versioned_docs/version-2.17/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/preamble.mdx b/versioned_docs/version-2.17/reference/subsystems/preamble.mdx index f59c85e46..f76904b26 100644 --- a/versioned_docs/version-2.17/reference/subsystems/preamble.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/preamble.mdx @@ -1,5 +1,7 @@ --- title: preamble +description: | + Formats files with a preamble, with the preamble looked up based on path. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.17/reference/subsystems/protobuf-java-grpc.mdx index 8c2287582..f12c561e9 100644 --- a/versioned_docs/version-2.17/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/protobuf-java-grpc.mdx @@ -1,5 +1,7 @@ --- title: protobuf-java-grpc +description: | + gRPC support for Java Protobuf (https://github.com/grpc/grpc-java) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/protoc.mdx b/versioned_docs/version-2.17/reference/subsystems/protoc.mdx index cf72c6b51..6ea2d2828 100644 --- a/versioned_docs/version-2.17/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/pydocstyle.mdx b/versioned_docs/version-2.17/reference/subsystems/pydocstyle.mdx index 3c7184fec..19e706967 100644 --- a/versioned_docs/version-2.17/reference/subsystems/pydocstyle.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/pydocstyle.mdx @@ -1,5 +1,7 @@ --- title: pydocstyle +description: | + A tool for checking compliance with Python docstring conventions (http://www.pydocstyle.org/en/stable/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/pylint.mdx b/versioned_docs/version-2.17/reference/subsystems/pylint.mdx index e478dc5dc..fa547d8a3 100644 --- a/versioned_docs/version-2.17/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.17/reference/subsystems/pyoxidizer.mdx index d533bb441..d9b3ad078 100644 --- a/versioned_docs/version-2.17/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/pytest.mdx b/versioned_docs/version-2.17/reference/subsystems/pytest.mdx index 2dbbde895..5542ad303 100644 --- a/versioned_docs/version-2.17/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.17/reference/subsystems/python-bootstrap.mdx index 4c0b755ad..af1770194 100644 --- a/versioned_docs/version-2.17/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.17/reference/subsystems/python-infer.mdx index 84bc1c0c6..ab1a91431 100644 --- a/versioned_docs/version-2.17/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.17/reference/subsystems/python-native-code.mdx index 766ddeedb..dfdb91103 100644 --- a/versioned_docs/version-2.17/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.17/reference/subsystems/python-protobuf.mdx index aa814bd3b..a39182b46 100644 --- a/versioned_docs/version-2.17/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.17/reference/subsystems/python-repos.mdx index 4aac49439..64bafb3eb 100644 --- a/versioned_docs/version-2.17/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.17/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/versioned_docs/version-2.17/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/python.mdx b/versioned_docs/version-2.17/reference/subsystems/python.mdx index 3d7285f6c..f3adcca0a 100644 --- a/versioned_docs/version-2.17/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.17/reference/subsystems/pyupgrade.mdx index 65f11f7b8..4d5627716 100644 --- a/versioned_docs/version-2.17/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.17/reference/subsystems/regex-lint.mdx index 34376a064..0ae838c11 100644 --- a/versioned_docs/version-2.17/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/ruff.mdx b/versioned_docs/version-2.17/reference/subsystems/ruff.mdx index 297485fdd..24a5ee5ba 100644 --- a/versioned_docs/version-2.17/reference/subsystems/ruff.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/ruff.mdx @@ -1,5 +1,7 @@ --- title: ruff +description: | + The Ruff Python formatter (https://github.com/charliermarsh/ruff). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.17/reference/subsystems/scala-infer.mdx index e1d0849de..f8a953742 100644 --- a/versioned_docs/version-2.17/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/scala.mdx b/versioned_docs/version-2.17/reference/subsystems/scala.mdx index b55c6b2ae..8184f5acf 100644 --- a/versioned_docs/version-2.17/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/scalac.mdx b/versioned_docs/version-2.17/reference/subsystems/scalac.mdx index 93dd5914c..d2ddec7ca 100644 --- a/versioned_docs/version-2.17/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.17/reference/subsystems/scalafmt.mdx index 3be1a0b05..c8e60b4e2 100644 --- a/versioned_docs/version-2.17/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.17/reference/subsystems/scalapb.mdx index 35db9527e..9c270c67a 100644 --- a/versioned_docs/version-2.17/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.17/reference/subsystems/scalatest.mdx index 2ed8e5de2..b36a498db 100644 --- a/versioned_docs/version-2.17/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/scc.mdx b/versioned_docs/version-2.17/reference/subsystems/scc.mdx index 543df5b0c..9dac5e6c6 100644 --- a/versioned_docs/version-2.17/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.17/reference/subsystems/setup-py-generation.mdx index 1f5e97187..5f9ca632c 100644 --- a/versioned_docs/version-2.17/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/setuptools-scm.mdx b/versioned_docs/version-2.17/reference/subsystems/setuptools-scm.mdx index 04f83bea2..706a8a4b3 100644 --- a/versioned_docs/version-2.17/reference/subsystems/setuptools-scm.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/setuptools-scm.mdx @@ -1,5 +1,7 @@ --- title: setuptools-scm +description: | + A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.17/reference/subsystems/setuptools.mdx index a3ee93a75..a3095e3e0 100644 --- a/versioned_docs/version-2.17/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.17/reference/subsystems/shell-setup.mdx index 26bb6f1c9..6affb0d9b 100644 --- a/versioned_docs/version-2.17/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/shell-test.mdx b/versioned_docs/version-2.17/reference/subsystems/shell-test.mdx index 489c11311..311238694 100644 --- a/versioned_docs/version-2.17/reference/subsystems/shell-test.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/shell-test.mdx @@ -1,5 +1,7 @@ --- title: shell-test +description: | + Options for Pants' Shell test support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.17/reference/subsystems/shellcheck.mdx index bc8e005b9..ca4f7571d 100644 --- a/versioned_docs/version-2.17/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.17/reference/subsystems/shfmt.mdx index 0952d1fcd..0c207dfb9 100644 --- a/versioned_docs/version-2.17/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/shunit2.mdx b/versioned_docs/version-2.17/reference/subsystems/shunit2.mdx index 7cb4ebb70..70b75b4f7 100644 --- a/versioned_docs/version-2.17/reference/subsystems/shunit2.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/shunit2.mdx @@ -1,5 +1,7 @@ --- title: shunit2 +description: | + shUnit2 is a xUnit framework for Bourne based shell scripts (https://github.com/kward/shunit2) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/source.mdx b/versioned_docs/version-2.17/reference/subsystems/source.mdx index 26f2aa762..18b89c050 100644 --- a/versioned_docs/version-2.17/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/spectral.mdx b/versioned_docs/version-2.17/reference/subsystems/spectral.mdx index d924e6c5c..6eb8c493e 100644 --- a/versioned_docs/version-2.17/reference/subsystems/spectral.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/spectral.mdx @@ -1,5 +1,7 @@ --- title: spectral +description: | + A flexible JSON/YAML linter for creating automated style guides (https://github.com/stoplightio/spectral). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/stats.mdx b/versioned_docs/version-2.17/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.17/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.17/reference/subsystems/subprocess-environment.mdx index 1cad2d6f8..6a097d496 100644 --- a/versioned_docs/version-2.17/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/terraform-fmt.mdx b/versioned_docs/version-2.17/reference/subsystems/terraform-fmt.mdx index 49bbf119b..e967d1f9c 100644 --- a/versioned_docs/version-2.17/reference/subsystems/terraform-fmt.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/terraform-hcl2-parser.mdx b/versioned_docs/version-2.17/reference/subsystems/terraform-hcl2-parser.mdx index 427709044..46e2e5419 100644 --- a/versioned_docs/version-2.17/reference/subsystems/terraform-hcl2-parser.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/terraform-validate.mdx b/versioned_docs/version-2.17/reference/subsystems/terraform-validate.mdx index edb178a87..6cb16de11 100644 --- a/versioned_docs/version-2.17/reference/subsystems/terraform-validate.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/thrift.mdx b/versioned_docs/version-2.17/reference/subsystems/thrift.mdx index 230854701..7a691f82d 100644 --- a/versioned_docs/version-2.17/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/twine.mdx b/versioned_docs/version-2.17/reference/subsystems/twine.mdx index 4fe85b235..adc072da2 100644 --- a/versioned_docs/version-2.17/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPI and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/workunit-logger.mdx b/versioned_docs/version-2.17/reference/subsystems/workunit-logger.mdx index a33434a0e..09183ea36 100644 --- a/versioned_docs/version-2.17/reference/subsystems/workunit-logger.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/workunit-logger.mdx @@ -1,5 +1,7 @@ --- title: workunit-logger +description: | + Workunit Logger subsystem. Useful for debugging pants itself. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/yamllint.mdx b/versioned_docs/version-2.17/reference/subsystems/yamllint.mdx index acc6495a5..2fc61adb0 100644 --- a/versioned_docs/version-2.17/reference/subsystems/yamllint.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/yamllint.mdx @@ -1,5 +1,7 @@ --- title: yamllint +description: | + A linter for YAML files (https://yamllint.readthedocs.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/subsystems/yapf.mdx b/versioned_docs/version-2.17/reference/subsystems/yapf.mdx index a2f8d8373..eb8655c40 100644 --- a/versioned_docs/version-2.17/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.17/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.17/reference/targets/adhoc_tool.mdx b/versioned_docs/version-2.17/reference/targets/adhoc_tool.mdx index 985e36caa..8b2d1dd9a 100644 --- a/versioned_docs/version-2.17/reference/targets/adhoc_tool.mdx +++ b/versioned_docs/version-2.17/reference/targets/adhoc_tool.mdx @@ -1,5 +1,7 @@ --- title: adhoc_tool +description: | + Execute any runnable target for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/archive.mdx b/versioned_docs/version-2.17/reference/targets/archive.mdx index b3f69629d..114cb1b42 100644 --- a/versioned_docs/version-2.17/reference/targets/archive.mdx +++ b/versioned_docs/version-2.17/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.17/reference/targets/deploy_jar.mdx index 21e983cb7..59c33c742 100644 --- a/versioned_docs/version-2.17/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.17/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/docker_environment.mdx b/versioned_docs/version-2.17/reference/targets/docker_environment.mdx index 933d8dd92..9984783ae 100644 --- a/versioned_docs/version-2.17/reference/targets/docker_environment.mdx +++ b/versioned_docs/version-2.17/reference/targets/docker_environment.mdx @@ -1,5 +1,7 @@ --- title: docker_environment +description: | + Configuration of a Docker environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/docker_image.mdx b/versioned_docs/version-2.17/reference/targets/docker_image.mdx index 67314981d..930a0e6ea 100644 --- a/versioned_docs/version-2.17/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.17/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/experimental_test_shell_command.mdx b/versioned_docs/version-2.17/reference/targets/experimental_test_shell_command.mdx index 58eccc73a..7fbf84805 100644 --- a/versioned_docs/version-2.17/reference/targets/experimental_test_shell_command.mdx +++ b/versioned_docs/version-2.17/reference/targets/experimental_test_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_test_shell_command +description: | + Run a script as a test via the `test` goal, with all dependencies packaged/copied available in the chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_go_package_sources.mdx b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_go_package_sources.mdx index 0630639a4..b12d53c8d 100644 --- a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_go_package_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_go_package_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_go_package_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `GoPackageSourcesField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_java_sources.mdx b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_java_sources.mdx index ff3e04681..c3c6f8c4d 100644 --- a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_java_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_java_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_java_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `JavaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_kotlin_sources.mdx b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_kotlin_sources.mdx index bae3428a7..a17b55a26 100644 --- a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_kotlin_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_kotlin_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `KotlinSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_python_sources.mdx b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_python_sources.mdx index 5751ec09f..169ffa6c2 100644 --- a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_python_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_python_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_python_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `PythonSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_resources.mdx b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_resources.mdx index 7f60252a5..01b2659c6 100644 --- a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_resources.mdx +++ b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_resources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_resources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ResourceSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_scala_sources.mdx b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_scala_sources.mdx index 5548c481b..d08d758a2 100644 --- a/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_scala_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/experimental_wrap_as_scala_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_scala_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ScalaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/file.mdx b/versioned_docs/version-2.17/reference/targets/file.mdx index 157214412..40b421d6e 100644 --- a/versioned_docs/version-2.17/reference/targets/file.mdx +++ b/versioned_docs/version-2.17/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/files.mdx b/versioned_docs/version-2.17/reference/targets/files.mdx index 396266b7d..cd0f8379f 100644 --- a/versioned_docs/version-2.17/reference/targets/files.mdx +++ b/versioned_docs/version-2.17/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/go_binary.mdx b/versioned_docs/version-2.17/reference/targets/go_binary.mdx index e1a85a7a6..3762d6c9d 100644 --- a/versioned_docs/version-2.17/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.17/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/go_mod.mdx b/versioned_docs/version-2.17/reference/targets/go_mod.mdx index a0cfd6173..eddaa16fd 100644 --- a/versioned_docs/version-2.17/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.17/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/go_package.mdx b/versioned_docs/version-2.17/reference/targets/go_package.mdx index 0713e4102..74af0751e 100644 --- a/versioned_docs/version-2.17/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.17/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.17/reference/targets/go_third_party_package.mdx index 909c2507f..195b6d265 100644 --- a/versioned_docs/version-2.17/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.17/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/helm_artifact.mdx b/versioned_docs/version-2.17/reference/targets/helm_artifact.mdx index df2c66974..3278b9c18 100644 --- a/versioned_docs/version-2.17/reference/targets/helm_artifact.mdx +++ b/versioned_docs/version-2.17/reference/targets/helm_artifact.mdx @@ -1,5 +1,7 @@ --- title: helm_artifact +description: | + A third party Helm artifact. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/helm_chart.mdx b/versioned_docs/version-2.17/reference/targets/helm_chart.mdx index 284c9d0ad..10d04010a 100644 --- a/versioned_docs/version-2.17/reference/targets/helm_chart.mdx +++ b/versioned_docs/version-2.17/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/helm_deployment.mdx b/versioned_docs/version-2.17/reference/targets/helm_deployment.mdx index df5081697..45239e186 100644 --- a/versioned_docs/version-2.17/reference/targets/helm_deployment.mdx +++ b/versioned_docs/version-2.17/reference/targets/helm_deployment.mdx @@ -1,5 +1,7 @@ --- title: helm_deployment +description: | + A Helm chart deployment. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/helm_unittest_test.mdx b/versioned_docs/version-2.17/reference/targets/helm_unittest_test.mdx index 97331affa..657bdbfba 100644 --- a/versioned_docs/version-2.17/reference/targets/helm_unittest_test.mdx +++ b/versioned_docs/version-2.17/reference/targets/helm_unittest_test.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_test +description: | + A single helm-unittest suite file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/helm_unittest_tests.mdx b/versioned_docs/version-2.17/reference/targets/helm_unittest_tests.mdx index a18e10877..e085046ee 100644 --- a/versioned_docs/version-2.17/reference/targets/helm_unittest_tests.mdx +++ b/versioned_docs/version-2.17/reference/targets/helm_unittest_tests.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_tests +description: | + Generates a `helm_unittest_test` target per each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/java_source.mdx b/versioned_docs/version-2.17/reference/targets/java_source.mdx index ba236709e..2f3ffdbb8 100644 --- a/versioned_docs/version-2.17/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.17/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/java_sources.mdx b/versioned_docs/version-2.17/reference/targets/java_sources.mdx index bea400570..6022f129e 100644 --- a/versioned_docs/version-2.17/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/junit_test.mdx b/versioned_docs/version-2.17/reference/targets/junit_test.mdx index 0c23c5786..5c4042101 100644 --- a/versioned_docs/version-2.17/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.17/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/junit_tests.mdx b/versioned_docs/version-2.17/reference/targets/junit_tests.mdx index 900655a97..9b8812872 100644 --- a/versioned_docs/version-2.17/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.17/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.17/reference/targets/jvm_artifact.mdx index cc35d00e5..0b814f249 100644 --- a/versioned_docs/version-2.17/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.17/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/jvm_war.mdx b/versioned_docs/version-2.17/reference/targets/jvm_war.mdx index 4eb8d48f7..e4a134487 100644 --- a/versioned_docs/version-2.17/reference/targets/jvm_war.mdx +++ b/versioned_docs/version-2.17/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/kotlin_junit_test.mdx b/versioned_docs/version-2.17/reference/targets/kotlin_junit_test.mdx index 4ea2bbc0f..4ebf95819 100644 --- a/versioned_docs/version-2.17/reference/targets/kotlin_junit_test.mdx +++ b/versioned_docs/version-2.17/reference/targets/kotlin_junit_test.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_test +description: | + A single Kotlin test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/kotlin_junit_tests.mdx b/versioned_docs/version-2.17/reference/targets/kotlin_junit_tests.mdx index eb05e9e9f..bd015620c 100644 --- a/versioned_docs/version-2.17/reference/targets/kotlin_junit_tests.mdx +++ b/versioned_docs/version-2.17/reference/targets/kotlin_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_tests +description: | + Generate a `kotlin_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/kotlin_source.mdx b/versioned_docs/version-2.17/reference/targets/kotlin_source.mdx index dd0113246..794309ce5 100644 --- a/versioned_docs/version-2.17/reference/targets/kotlin_source.mdx +++ b/versioned_docs/version-2.17/reference/targets/kotlin_source.mdx @@ -1,5 +1,7 @@ --- title: kotlin_source +description: | + A single Kotlin source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/kotlin_sources.mdx b/versioned_docs/version-2.17/reference/targets/kotlin_sources.mdx index 7ad97ac88..08c93f09b 100644 --- a/versioned_docs/version-2.17/reference/targets/kotlin_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: kotlin_sources +description: | + Generate a `kotlin_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/kotlinc_plugin.mdx b/versioned_docs/version-2.17/reference/targets/kotlinc_plugin.mdx index 828754fa0..2614957de 100644 --- a/versioned_docs/version-2.17/reference/targets/kotlinc_plugin.mdx +++ b/versioned_docs/version-2.17/reference/targets/kotlinc_plugin.mdx @@ -1,5 +1,7 @@ --- title: kotlinc_plugin +description: | + A plugin for `kotlinc`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/local_environment.mdx b/versioned_docs/version-2.17/reference/targets/local_environment.mdx index 1867767ac..0c0fb6111 100644 --- a/versioned_docs/version-2.17/reference/targets/local_environment.mdx +++ b/versioned_docs/version-2.17/reference/targets/local_environment.mdx @@ -1,5 +1,7 @@ --- title: local_environment +description: | + Configuration of a local execution environment for specific platforms. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/openapi_document.mdx b/versioned_docs/version-2.17/reference/targets/openapi_document.mdx index 7b52b0275..eee633c59 100644 --- a/versioned_docs/version-2.17/reference/targets/openapi_document.mdx +++ b/versioned_docs/version-2.17/reference/targets/openapi_document.mdx @@ -1,5 +1,7 @@ --- title: openapi_document +description: | + A single OpenAPI document file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/openapi_documents.mdx b/versioned_docs/version-2.17/reference/targets/openapi_documents.mdx index 58827613f..9da9f3ca0 100644 --- a/versioned_docs/version-2.17/reference/targets/openapi_documents.mdx +++ b/versioned_docs/version-2.17/reference/targets/openapi_documents.mdx @@ -1,5 +1,7 @@ --- title: openapi_documents +description: | + Generate an `openapi_document` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/openapi_source.mdx b/versioned_docs/version-2.17/reference/targets/openapi_source.mdx index e9ba3532e..cf0d10fb2 100644 --- a/versioned_docs/version-2.17/reference/targets/openapi_source.mdx +++ b/versioned_docs/version-2.17/reference/targets/openapi_source.mdx @@ -1,5 +1,7 @@ --- title: openapi_source +description: | + A single OpenAPI source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/openapi_sources.mdx b/versioned_docs/version-2.17/reference/targets/openapi_sources.mdx index 1bd105968..6b2709496 100644 --- a/versioned_docs/version-2.17/reference/targets/openapi_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/openapi_sources.mdx @@ -1,5 +1,7 @@ --- title: openapi_sources +description: | + Generate an `openapi_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.17/reference/targets/pants_requirements.mdx index c31b71e88..c81130f33 100644 --- a/versioned_docs/version-2.17/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.17/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.17/reference/targets/pex_binaries.mdx index d12778caa..9dcbe4b8b 100644 --- a/versioned_docs/version-2.17/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.17/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/pex_binary.mdx b/versioned_docs/version-2.17/reference/targets/pex_binary.mdx index a1a06b3b4..f3fb188cd 100644 --- a/versioned_docs/version-2.17/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.17/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.17/reference/targets/pipenv_requirements.mdx index f67f613c7..8232eece0 100644 --- a/versioned_docs/version-2.17/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.17/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.17/reference/targets/poetry_requirements.mdx index 6edf88e02..b33cbf23b 100644 --- a/versioned_docs/version-2.17/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.17/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry `pyproject.toml`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.17/reference/targets/protobuf_source.mdx index 7684d6752..c3ad90c2e 100644 --- a/versioned_docs/version-2.17/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.17/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.17/reference/targets/protobuf_sources.mdx index dbac4775e..58c3b69fc 100644 --- a/versioned_docs/version-2.17/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.17/reference/targets/pyoxidizer_binary.mdx index 47a996a4f..b885a2818 100644 --- a/versioned_docs/version-2.17/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.17/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.17/reference/targets/python_awslambda.mdx index 4ddb05808..9cf4a608e 100644 --- a/versioned_docs/version-2.17/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_distribution.mdx b/versioned_docs/version-2.17/reference/targets/python_distribution.mdx index ea4611d04..957a0048a 100644 --- a/versioned_docs/version-2.17/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.17/reference/targets/python_google_cloud_function.mdx index 0c81f50a4..98a434d73 100644 --- a/versioned_docs/version-2.17/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_requirement.mdx b/versioned_docs/version-2.17/reference/targets/python_requirement.mdx index a875cc367..c16b0b618 100644 --- a/versioned_docs/version-2.17/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_requirements.mdx b/versioned_docs/version-2.17/reference/targets/python_requirements.mdx index b4078a301..a891310f2 100644 --- a/versioned_docs/version-2.17/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style or PEP 621 compliant `pyproject.toml` file. The choice of parser for the `source` field is determined by the file name. If the `source` field ends with `pyproject.toml`, then the file is assumed to be a PEP 621 compliant file. Any other file name uses the requirements.txt-style parser. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_source.mdx b/versioned_docs/version-2.17/reference/targets/python_source.mdx index af7d80f24..a82e55a3a 100644 --- a/versioned_docs/version-2.17/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_sources.mdx b/versioned_docs/version-2.17/reference/targets/python_sources.mdx index cf48c4fd5..bb0b28208 100644 --- a/versioned_docs/version-2.17/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_test.mdx b/versioned_docs/version-2.17/reference/targets/python_test.mdx index 80e1f197c..3ec7fd17f 100644 --- a/versioned_docs/version-2.17/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.17/reference/targets/python_test_utils.mdx index ac21edd4d..80ee3e8ad 100644 --- a/versioned_docs/version-2.17/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/python_tests.mdx b/versioned_docs/version-2.17/reference/targets/python_tests.mdx index 5954c1084..d3eebba1c 100644 --- a/versioned_docs/version-2.17/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.17/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/relocated_files.mdx b/versioned_docs/version-2.17/reference/targets/relocated_files.mdx index 346339e69..9efc94ea5 100644 --- a/versioned_docs/version-2.17/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.17/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/remote_environment.mdx b/versioned_docs/version-2.17/reference/targets/remote_environment.mdx index 30f4785b7..fee2d75bc 100644 --- a/versioned_docs/version-2.17/reference/targets/remote_environment.mdx +++ b/versioned_docs/version-2.17/reference/targets/remote_environment.mdx @@ -1,5 +1,7 @@ --- title: remote_environment +description: | + Configuration of a remote execution environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/resource.mdx b/versioned_docs/version-2.17/reference/targets/resource.mdx index d949720b9..abc8b5f2f 100644 --- a/versioned_docs/version-2.17/reference/targets/resource.mdx +++ b/versioned_docs/version-2.17/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/resources.mdx b/versioned_docs/version-2.17/reference/targets/resources.mdx index 27bbd3dbf..d989018cc 100644 --- a/versioned_docs/version-2.17/reference/targets/resources.mdx +++ b/versioned_docs/version-2.17/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/run_shell_command.mdx b/versioned_docs/version-2.17/reference/targets/run_shell_command.mdx index bf8dfe79c..e705072a2 100644 --- a/versioned_docs/version-2.17/reference/targets/run_shell_command.mdx +++ b/versioned_docs/version-2.17/reference/targets/run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.17/reference/targets/scala_junit_test.mdx index 9dea5e3ce..99e03202a 100644 --- a/versioned_docs/version-2.17/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.17/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.17/reference/targets/scala_junit_tests.mdx index c5f8293f1..4899c55f6 100644 --- a/versioned_docs/version-2.17/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.17/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/scala_source.mdx b/versioned_docs/version-2.17/reference/targets/scala_source.mdx index c793d55b1..a1788bf52 100644 --- a/versioned_docs/version-2.17/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.17/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/scala_sources.mdx b/versioned_docs/version-2.17/reference/targets/scala_sources.mdx index d6c6f22c2..9eec0c627 100644 --- a/versioned_docs/version-2.17/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.17/reference/targets/scalac_plugin.mdx index b67cbac68..0763f19da 100644 --- a/versioned_docs/version-2.17/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.17/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.17/reference/targets/scalatest_test.mdx index 3818e7eae..993ba982f 100644 --- a/versioned_docs/version-2.17/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.17/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.17/reference/targets/scalatest_tests.mdx index 5a528cdf5..684c203bd 100644 --- a/versioned_docs/version-2.17/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.17/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching `('*Spec.scala', '*Suite.scala')`). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/shell_command.mdx b/versioned_docs/version-2.17/reference/targets/shell_command.mdx index 507f27c3c..cf50a07ed 100644 --- a/versioned_docs/version-2.17/reference/targets/shell_command.mdx +++ b/versioned_docs/version-2.17/reference/targets/shell_command.mdx @@ -1,5 +1,7 @@ --- title: shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/shell_source.mdx b/versioned_docs/version-2.17/reference/targets/shell_source.mdx index adad94090..7a0810f8b 100644 --- a/versioned_docs/version-2.17/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.17/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/shell_sources.mdx b/versioned_docs/version-2.17/reference/targets/shell_sources.mdx index 512ca2d97..ec0edd064 100644 --- a/versioned_docs/version-2.17/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.17/reference/targets/shunit2_test.mdx index 3a9c1c39c..19157da44 100644 --- a/versioned_docs/version-2.17/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.17/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.17/reference/targets/shunit2_tests.mdx index c813e72cc..1862bc3ea 100644 --- a/versioned_docs/version-2.17/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.17/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/system_binary.mdx b/versioned_docs/version-2.17/reference/targets/system_binary.mdx index d7bd775a0..017c61020 100644 --- a/versioned_docs/version-2.17/reference/targets/system_binary.mdx +++ b/versioned_docs/version-2.17/reference/targets/system_binary.mdx @@ -1,5 +1,7 @@ --- title: system_binary +description: | + A system binary that can be run with `pants run` or consumed by `adhoc_tool`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/target.mdx b/versioned_docs/version-2.17/reference/targets/target.mdx index c31ddeaed..0f674f2a2 100644 --- a/versioned_docs/version-2.17/reference/targets/target.mdx +++ b/versioned_docs/version-2.17/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/terraform_module.mdx b/versioned_docs/version-2.17/reference/targets/terraform_module.mdx index 0f2ad9974..23e9d5fe2 100644 --- a/versioned_docs/version-2.17/reference/targets/terraform_module.mdx +++ b/versioned_docs/version-2.17/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/thrift_source.mdx b/versioned_docs/version-2.17/reference/targets/thrift_source.mdx index 15a655891..e07ab026c 100644 --- a/versioned_docs/version-2.17/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.17/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.17/reference/targets/thrift_sources.mdx index 09d086a63..19227ce02 100644 --- a/versioned_docs/version-2.17/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.17/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.17/reference/targets/vcs_version.mdx b/versioned_docs/version-2.17/reference/targets/vcs_version.mdx index 47b639217..e9b7ad5d9 100644 --- a/versioned_docs/version-2.17/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.17/reference/targets/vcs_version.mdx @@ -1,5 +1,7 @@ --- title: vcs_version +description: | + Generates a version string from VCS state. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/global-options.mdx b/versioned_docs/version-2.18/reference/global-options.mdx index 3a3dd2d8e..3c3d1a600 100644 --- a/versioned_docs/version-2.18/reference/global-options.mdx +++ b/versioned_docs/version-2.18/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/check.mdx b/versioned_docs/version-2.18/reference/goals/check.mdx index 055b4584b..d2b292a1c 100644 --- a/versioned_docs/version-2.18/reference/goals/check.mdx +++ b/versioned_docs/version-2.18/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/count-loc.mdx b/versioned_docs/version-2.18/reference/goals/count-loc.mdx index fcd1ded48..1a9c711fe 100644 --- a/versioned_docs/version-2.18/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.18/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/dependees.mdx b/versioned_docs/version-2.18/reference/goals/dependees.mdx index c8d158961..4033c80d2 100644 --- a/versioned_docs/version-2.18/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.18/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/dependencies.mdx b/versioned_docs/version-2.18/reference/goals/dependencies.mdx index eecf7ea2a..4d03fb731 100644 --- a/versioned_docs/version-2.18/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.18/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/dependents.mdx b/versioned_docs/version-2.18/reference/goals/dependents.mdx index d8f395668..6727ab393 100644 --- a/versioned_docs/version-2.18/reference/goals/dependents.mdx +++ b/versioned_docs/version-2.18/reference/goals/dependents.mdx @@ -1,5 +1,7 @@ --- title: dependents +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.18/reference/goals/experimental-bsp.mdx index 6ffa7f417..fcc748c92 100644 --- a/versioned_docs/version-2.18/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.18/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/experimental-deploy.mdx b/versioned_docs/version-2.18/reference/goals/experimental-deploy.mdx index cedddbdf4..f437c6091 100644 --- a/versioned_docs/version-2.18/reference/goals/experimental-deploy.mdx +++ b/versioned_docs/version-2.18/reference/goals/experimental-deploy.mdx @@ -1,5 +1,7 @@ --- title: experimental-deploy +description: | + Perform a deployment process. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/experimental-explorer.mdx b/versioned_docs/version-2.18/reference/goals/experimental-explorer.mdx index eb5e42352..7df90e7dc 100644 --- a/versioned_docs/version-2.18/reference/goals/experimental-explorer.mdx +++ b/versioned_docs/version-2.18/reference/goals/experimental-explorer.mdx @@ -1,5 +1,7 @@ --- title: experimental-explorer +description: | + Run the Pants Explorer Web UI server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/export-codegen.mdx b/versioned_docs/version-2.18/reference/goals/export-codegen.mdx index 08f5cb08d..5ba91e387 100644 --- a/versioned_docs/version-2.18/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.18/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/export.mdx b/versioned_docs/version-2.18/reference/goals/export.mdx index bfb217a60..40e2c181a 100644 --- a/versioned_docs/version-2.18/reference/goals/export.mdx +++ b/versioned_docs/version-2.18/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/filedeps.mdx b/versioned_docs/version-2.18/reference/goals/filedeps.mdx index fadeb17a0..ea3763879 100644 --- a/versioned_docs/version-2.18/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.18/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/fix.mdx b/versioned_docs/version-2.18/reference/goals/fix.mdx index e06700269..46c842554 100644 --- a/versioned_docs/version-2.18/reference/goals/fix.mdx +++ b/versioned_docs/version-2.18/reference/goals/fix.mdx @@ -1,5 +1,7 @@ --- title: fix +description: | + Autofix source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/fmt.mdx b/versioned_docs/version-2.18/reference/goals/fmt.mdx index d9fa4f94b..35b8eef6b 100644 --- a/versioned_docs/version-2.18/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.18/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.18/reference/goals/generate-lockfiles.mdx index 174338416..08068b65d 100644 --- a/versioned_docs/version-2.18/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.18/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/generate-snapshots.mdx b/versioned_docs/version-2.18/reference/goals/generate-snapshots.mdx index d10694ebc..5eb68d024 100644 --- a/versioned_docs/version-2.18/reference/goals/generate-snapshots.mdx +++ b/versioned_docs/version-2.18/reference/goals/generate-snapshots.mdx @@ -1,5 +1,7 @@ --- title: generate-snapshots +description: | + Generate test snapshots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/go-generate.mdx b/versioned_docs/version-2.18/reference/goals/go-generate.mdx index 2157e99f4..dac9c78a0 100644 --- a/versioned_docs/version-2.18/reference/goals/go-generate.mdx +++ b/versioned_docs/version-2.18/reference/goals/go-generate.mdx @@ -1,5 +1,7 @@ --- title: go-generate +description: | + Run each command in a package described by a `//go:generate` directive. This is equivalent to running `go generate` on a Go package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/help-advanced.mdx b/versioned_docs/version-2.18/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.18/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.18/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/help-all.mdx b/versioned_docs/version-2.18/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.18/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.18/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/help.mdx b/versioned_docs/version-2.18/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.18/reference/goals/help.mdx +++ b/versioned_docs/version-2.18/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/lint.mdx b/versioned_docs/version-2.18/reference/goals/lint.mdx index 47aee7528..d33ccb3e6 100644 --- a/versioned_docs/version-2.18/reference/goals/lint.mdx +++ b/versioned_docs/version-2.18/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run linters/formatters/fixers in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/list.mdx b/versioned_docs/version-2.18/reference/goals/list.mdx index 78d49bb55..bc858f973 100644 --- a/versioned_docs/version-2.18/reference/goals/list.mdx +++ b/versioned_docs/version-2.18/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/package.mdx b/versioned_docs/version-2.18/reference/goals/package.mdx index 357be63d3..e6cb234d7 100644 --- a/versioned_docs/version-2.18/reference/goals/package.mdx +++ b/versioned_docs/version-2.18/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/paths.mdx b/versioned_docs/version-2.18/reference/goals/paths.mdx index 6ada5cf63..a2910f8b2 100644 --- a/versioned_docs/version-2.18/reference/goals/paths.mdx +++ b/versioned_docs/version-2.18/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. Either address may represent a group of targets, e.g. `--from=src/app/main.py --to=src/library::`. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/peek.mdx b/versioned_docs/version-2.18/reference/goals/peek.mdx index f42185cf3..4c54e6307 100644 --- a/versioned_docs/version-2.18/reference/goals/peek.mdx +++ b/versioned_docs/version-2.18/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/publish.mdx b/versioned_docs/version-2.18/reference/goals/publish.mdx index b6e9c59c8..2a90b4bd6 100644 --- a/versioned_docs/version-2.18/reference/goals/publish.mdx +++ b/versioned_docs/version-2.18/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/py-constraints.mdx b/versioned_docs/version-2.18/reference/goals/py-constraints.mdx index 21a5bf3a8..7c779befd 100644 --- a/versioned_docs/version-2.18/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.18/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/python-dump-source-analysis.mdx b/versioned_docs/version-2.18/reference/goals/python-dump-source-analysis.mdx index 935e0c1f4..55b086047 100644 --- a/versioned_docs/version-2.18/reference/goals/python-dump-source-analysis.mdx +++ b/versioned_docs/version-2.18/reference/goals/python-dump-source-analysis.mdx @@ -1,5 +1,7 @@ --- title: python-dump-source-analysis +description: | + Dump source analysis for python_source targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/repl.mdx b/versioned_docs/version-2.18/reference/goals/repl.mdx index 68db5eacc..5cb31f80d 100644 --- a/versioned_docs/version-2.18/reference/goals/repl.mdx +++ b/versioned_docs/version-2.18/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/roots.mdx b/versioned_docs/version-2.18/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.18/reference/goals/roots.mdx +++ b/versioned_docs/version-2.18/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/run.mdx b/versioned_docs/version-2.18/reference/goals/run.mdx index 4a26d2e66..0a3c0375e 100644 --- a/versioned_docs/version-2.18/reference/goals/run.mdx +++ b/versioned_docs/version-2.18/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/tailor.mdx b/versioned_docs/version-2.18/reference/goals/tailor.mdx index 6b4b8c0c1..e434f03f1 100644 --- a/versioned_docs/version-2.18/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.18/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/test.mdx b/versioned_docs/version-2.18/reference/goals/test.mdx index 28dea8143..92439f392 100644 --- a/versioned_docs/version-2.18/reference/goals/test.mdx +++ b/versioned_docs/version-2.18/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/update-build-files.mdx b/versioned_docs/version-2.18/reference/goals/update-build-files.mdx index 5c40544b0..0159d3d28 100644 --- a/versioned_docs/version-2.18/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.18/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/goals/version.mdx b/versioned_docs/version-2.18/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.18/reference/goals/version.mdx +++ b/versioned_docs/version-2.18/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/add-trailing-comma.mdx b/versioned_docs/version-2.18/reference/subsystems/add-trailing-comma.mdx index c5df16fb5..631972761 100644 --- a/versioned_docs/version-2.18/reference/subsystems/add-trailing-comma.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/add-trailing-comma.mdx @@ -1,5 +1,7 @@ --- title: add-trailing-comma +description: | + The add-trailing-comma Python code formatter (https://github.com/asottile/add-trailing-comma). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.18/reference/subsystems/anonymous-telemetry.mdx index 79fccd2a4..ffba0ba10 100644 --- a/versioned_docs/version-2.18/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.18/reference/subsystems/apache-thrift.mdx index 8cd006a9a..ebd400bea 100644 --- a/versioned_docs/version-2.18/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.18/reference/subsystems/autoflake.mdx index c924341e3..fc885d2fa 100644 --- a/versioned_docs/version-2.18/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/bandit.mdx b/versioned_docs/version-2.18/reference/subsystems/bandit.mdx index 2a3653167..a8a57e39b 100644 --- a/versioned_docs/version-2.18/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/black.mdx b/versioned_docs/version-2.18/reference/subsystems/black.mdx index d64717ad4..810b9e621 100644 --- a/versioned_docs/version-2.18/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/buf.mdx b/versioned_docs/version-2.18/reference/subsystems/buf.mdx index f1f07a565..8a6610906 100644 --- a/versioned_docs/version-2.18/reference/subsystems/buf.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/build-deprecations-fixer.mdx b/versioned_docs/version-2.18/reference/subsystems/build-deprecations-fixer.mdx index 0f9b51fe4..0f9f27cf9 100644 --- a/versioned_docs/version-2.18/reference/subsystems/build-deprecations-fixer.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/build-deprecations-fixer.mdx @@ -1,5 +1,7 @@ --- title: build-deprecations-fixer +description: | + A tool/plugin for fixing BUILD file deprecations (where possible). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/buildifier.mdx b/versioned_docs/version-2.18/reference/subsystems/buildifier.mdx index 917e04970..dd2e76ef4 100644 --- a/versioned_docs/version-2.18/reference/subsystems/buildifier.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/buildifier.mdx @@ -1,5 +1,7 @@ --- title: buildifier +description: | + Buildifier is a tool for formatting BUILD files with a standard convention. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/changed.mdx b/versioned_docs/version-2.18/reference/subsystems/changed.mdx index 5d03a085e..81b361f57 100644 --- a/versioned_docs/version-2.18/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/cli.mdx b/versioned_docs/version-2.18/reference/subsystems/cli.mdx index 7a12ca8ca..c1d3d782d 100644 --- a/versioned_docs/version-2.18/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/coursier.mdx b/versioned_docs/version-2.18/reference/subsystems/coursier.mdx index 80143fcf7..c30782561 100644 --- a/versioned_docs/version-2.18/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. (https://get-coursier.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.18/reference/subsystems/coverage-py.mdx index d0742419a..200450694 100644 --- a/versioned_docs/version-2.18/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/debug-adapter.mdx b/versioned_docs/version-2.18/reference/subsystems/debug-adapter.mdx index d15f05658..655c51060 100644 --- a/versioned_docs/version-2.18/reference/subsystems/debug-adapter.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/debug-adapter.mdx @@ -1,5 +1,7 @@ --- title: debug-adapter +description: | + Options used to configure and launch a Debug Adapter server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/debugpy.mdx b/versioned_docs/version-2.18/reference/subsystems/debugpy.mdx index 3abb75254..334f1aca0 100644 --- a/versioned_docs/version-2.18/reference/subsystems/debugpy.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/debugpy.mdx @@ -1,5 +1,7 @@ --- title: debugpy +description: | + An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.18/reference/subsystems/docformatter.mdx index 2b9f99465..03cd1943c 100644 --- a/versioned_docs/version-2.18/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/docker.mdx b/versioned_docs/version-2.18/reference/subsystems/docker.mdx index 60e698bd9..80ce1a8fc 100644 --- a/versioned_docs/version-2.18/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.18/reference/subsystems/dockerfile-parser.mdx index 81ff2e6bc..30e11f8c3 100644 --- a/versioned_docs/version-2.18/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/download-terraform.mdx b/versioned_docs/version-2.18/reference/subsystems/download-terraform.mdx index 8dfc231f0..e931fba91 100644 --- a/versioned_docs/version-2.18/reference/subsystems/download-terraform.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/environments-preview.mdx b/versioned_docs/version-2.18/reference/subsystems/environments-preview.mdx index 780bc8363..8231798c1 100644 --- a/versioned_docs/version-2.18/reference/subsystems/environments-preview.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/environments-preview.mdx @@ -1,5 +1,7 @@ --- title: environments-preview +description: | + A highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/filter.mdx b/versioned_docs/version-2.18/reference/subsystems/filter.mdx index 2a6c4cef6..490732a64 100644 --- a/versioned_docs/version-2.18/reference/subsystems/filter.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/flake8.mdx b/versioned_docs/version-2.18/reference/subsystems/flake8.mdx index 53891efa8..80b739ec7 100644 --- a/versioned_docs/version-2.18/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/go-test.mdx b/versioned_docs/version-2.18/reference/subsystems/go-test.mdx index 9f356582a..1e6939a1c 100644 --- a/versioned_docs/version-2.18/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.18/reference/subsystems/gofmt.mdx index 83a3eb9a5..e54bcdc75 100644 --- a/versioned_docs/version-2.18/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/golang.mdx b/versioned_docs/version-2.18/reference/subsystems/golang.mdx index 743947589..b9fd30c5f 100644 --- a/versioned_docs/version-2.18/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.18/reference/subsystems/google-java-format.mdx index 923d087c8..517165325 100644 --- a/versioned_docs/version-2.18/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.18/reference/subsystems/grpc-python-plugin.mdx index 0f377add9..127a942f4 100644 --- a/versioned_docs/version-2.18/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.18/reference/subsystems/hadolint.mdx index 8c649f9cd..5ad17dd33 100644 --- a/versioned_docs/version-2.18/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/helm-k8s-parser.mdx b/versioned_docs/version-2.18/reference/subsystems/helm-k8s-parser.mdx index 4b3f14090..27cadb6e1 100644 --- a/versioned_docs/version-2.18/reference/subsystems/helm-k8s-parser.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/helm-k8s-parser.mdx @@ -1,5 +1,7 @@ --- title: helm-k8s-parser +description: | + Analyses K8S manifests rendered by Helm. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/helm-post-renderer.mdx b/versioned_docs/version-2.18/reference/subsystems/helm-post-renderer.mdx index cfb7cdb7a..d69ef62e8 100644 --- a/versioned_docs/version-2.18/reference/subsystems/helm-post-renderer.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/helm-post-renderer.mdx @@ -1,5 +1,7 @@ --- title: helm-post-renderer +description: | + Used perform modifications to the final output produced by Helm charts when they've been fully rendered. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/helm-unittest.mdx b/versioned_docs/version-2.18/reference/subsystems/helm-unittest.mdx index 47e2d27cf..1144d97aa 100644 --- a/versioned_docs/version-2.18/reference/subsystems/helm-unittest.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/helm-unittest.mdx @@ -1,5 +1,7 @@ --- title: helm-unittest +description: | + BDD styled unit test framework for Kubernetes Helm charts as a Helm plugin. (https://github.com/helm-unittest) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/helm.mdx b/versioned_docs/version-2.18/reference/subsystems/helm.mdx index f02a0306a..bc11144cb 100644 --- a/versioned_docs/version-2.18/reference/subsystems/helm.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/ipython.mdx b/versioned_docs/version-2.18/reference/subsystems/ipython.mdx index b03e801e3..2c617c6d3 100644 --- a/versioned_docs/version-2.18/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/isort.mdx b/versioned_docs/version-2.18/reference/subsystems/isort.mdx index 07877b2db..c6b43f49a 100644 --- a/versioned_docs/version-2.18/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/jarjar.mdx b/versioned_docs/version-2.18/reference/subsystems/jarjar.mdx index 134cba994..fc9c7aff0 100644 --- a/versioned_docs/version-2.18/reference/subsystems/jarjar.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/jarjar.mdx @@ -1,5 +1,7 @@ --- title: jarjar +description: | + The Jar Jar Abrams tool (https://github.com/eed3si9n/jarjar-abrams) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.18/reference/subsystems/java-infer.mdx index 9b365727f..2088e9ff2 100644 --- a/versioned_docs/version-2.18/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/javac.mdx b/versioned_docs/version-2.18/reference/subsystems/javac.mdx index 32f80db89..a7ac13086 100644 --- a/versioned_docs/version-2.18/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/junit.mdx b/versioned_docs/version-2.18/reference/subsystems/junit.mdx index e18eefcd7..c7b00bbcb 100644 --- a/versioned_docs/version-2.18/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/jvm.mdx b/versioned_docs/version-2.18/reference/subsystems/jvm.mdx index 20f80de22..4cee79248 100644 --- a/versioned_docs/version-2.18/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/kotlin-infer.mdx b/versioned_docs/version-2.18/reference/subsystems/kotlin-infer.mdx index 1241c712c..89eb838c9 100644 --- a/versioned_docs/version-2.18/reference/subsystems/kotlin-infer.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/kotlin-infer.mdx @@ -1,5 +1,7 @@ --- title: kotlin-infer +description: | + Options controlling which dependencies will be inferred for Kotlin targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/kotlin.mdx b/versioned_docs/version-2.18/reference/subsystems/kotlin.mdx index 25b150315..50785c245 100644 --- a/versioned_docs/version-2.18/reference/subsystems/kotlin.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/kotlin.mdx @@ -1,5 +1,7 @@ --- title: kotlin +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/kotlinc.mdx b/versioned_docs/version-2.18/reference/subsystems/kotlinc.mdx index 428423319..3c9d68d40 100644 --- a/versioned_docs/version-2.18/reference/subsystems/kotlinc.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/kotlinc.mdx @@ -1,5 +1,7 @@ --- title: kotlinc +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.18/reference/subsystems/ktlint.mdx index 724ec82a7..f061aa2b0 100644 --- a/versioned_docs/version-2.18/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/ktlint.mdx @@ -1,5 +1,7 @@ --- title: ktlint +description: | + Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.18/reference/subsystems/lambdex.mdx index a639688f7..f90da794c 100644 --- a/versioned_docs/version-2.18/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.18/reference/subsystems/mypy-protobuf.mdx index 4a4e14ad9..b1c2c355a 100644 --- a/versioned_docs/version-2.18/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/mypy.mdx b/versioned_docs/version-2.18/reference/subsystems/mypy.mdx index fa673b282..506f91d75 100644 --- a/versioned_docs/version-2.18/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/nodejs-infer.mdx b/versioned_docs/version-2.18/reference/subsystems/nodejs-infer.mdx index ce0f1a9c9..2c3454f99 100644 --- a/versioned_docs/version-2.18/reference/subsystems/nodejs-infer.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/nodejs-infer.mdx @@ -1,5 +1,7 @@ --- title: nodejs-infer +description: | + Options controlling which dependencies will be inferred for javascript targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/nodejs.mdx b/versioned_docs/version-2.18/reference/subsystems/nodejs.mdx index 15c11facb..6c9ed64dc 100644 --- a/versioned_docs/version-2.18/reference/subsystems/nodejs.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/nodejs.mdx @@ -1,5 +1,7 @@ --- title: nodejs +description: | + The Node.js Javascript runtime (including Corepack). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/openapi.mdx b/versioned_docs/version-2.18/reference/subsystems/openapi.mdx index e1bf02a46..78c72dfbc 100644 --- a/versioned_docs/version-2.18/reference/subsystems/openapi.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/openapi.mdx @@ -1,5 +1,7 @@ --- title: openapi +description: | + The OpenAPI Specification (https://swagger.io/specification/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.18/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.18/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.18/reference/subsystems/pex-cli.mdx index 2db79119d..9bd62a0b3 100644 --- a/versioned_docs/version-2.18/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/pex.mdx b/versioned_docs/version-2.18/reference/subsystems/pex.mdx index 6562ee0d6..368a1dc0d 100644 --- a/versioned_docs/version-2.18/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/preamble.mdx b/versioned_docs/version-2.18/reference/subsystems/preamble.mdx index 114f378e0..dcb1e80f0 100644 --- a/versioned_docs/version-2.18/reference/subsystems/preamble.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/preamble.mdx @@ -1,5 +1,7 @@ --- title: preamble +description: | + Formats files with a preamble, with the preamble looked up based on path. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.18/reference/subsystems/protobuf-java-grpc.mdx index e0b6df589..d7852a12f 100644 --- a/versioned_docs/version-2.18/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/protobuf-java-grpc.mdx @@ -1,5 +1,7 @@ --- title: protobuf-java-grpc +description: | + gRPC support for Java Protobuf (https://github.com/grpc/grpc-java) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/protoc.mdx b/versioned_docs/version-2.18/reference/subsystems/protoc.mdx index a97e6c2ea..73f2c9475 100644 --- a/versioned_docs/version-2.18/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/pydocstyle.mdx b/versioned_docs/version-2.18/reference/subsystems/pydocstyle.mdx index 8a68ee4eb..b68e9db35 100644 --- a/versioned_docs/version-2.18/reference/subsystems/pydocstyle.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/pydocstyle.mdx @@ -1,5 +1,7 @@ --- title: pydocstyle +description: | + A tool for checking compliance with Python docstring conventions (http://www.pydocstyle.org/en/stable/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/pylint.mdx b/versioned_docs/version-2.18/reference/subsystems/pylint.mdx index f8e7a4d07..67b8ae524 100644 --- a/versioned_docs/version-2.18/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.18/reference/subsystems/pyoxidizer.mdx index 884733e54..80105ad57 100644 --- a/versioned_docs/version-2.18/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/pytest.mdx b/versioned_docs/version-2.18/reference/subsystems/pytest.mdx index fef0e7dfc..120734a8a 100644 --- a/versioned_docs/version-2.18/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.18/reference/subsystems/python-bootstrap.mdx index 5cda622fb..679ed8005 100644 --- a/versioned_docs/version-2.18/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.18/reference/subsystems/python-infer.mdx index ab4e8adea..b8c07ad43 100644 --- a/versioned_docs/version-2.18/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.18/reference/subsystems/python-native-code.mdx index 766ddeedb..dfdb91103 100644 --- a/versioned_docs/version-2.18/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.18/reference/subsystems/python-protobuf.mdx index 9902749f1..c06f9b58d 100644 --- a/versioned_docs/version-2.18/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.18/reference/subsystems/python-repos.mdx index 263a9271b..67cb9b926 100644 --- a/versioned_docs/version-2.18/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.18/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/versioned_docs/version-2.18/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/python.mdx b/versioned_docs/version-2.18/reference/subsystems/python.mdx index a15775a95..34f25daaf 100644 --- a/versioned_docs/version-2.18/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/pytype.mdx b/versioned_docs/version-2.18/reference/subsystems/pytype.mdx index 673ee8c8b..2c71101f1 100644 --- a/versioned_docs/version-2.18/reference/subsystems/pytype.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/pytype.mdx @@ -1,5 +1,7 @@ --- title: pytype +description: | + The Pytype utility for typechecking Python code (https://github.com/google/pytype). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.18/reference/subsystems/pyupgrade.mdx index 370450050..7e136a2ae 100644 --- a/versioned_docs/version-2.18/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.18/reference/subsystems/regex-lint.mdx index 34376a064..0ae838c11 100644 --- a/versioned_docs/version-2.18/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/ruff.mdx b/versioned_docs/version-2.18/reference/subsystems/ruff.mdx index eb4206523..446ebf3d4 100644 --- a/versioned_docs/version-2.18/reference/subsystems/ruff.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/ruff.mdx @@ -1,5 +1,7 @@ --- title: ruff +description: | + The Ruff Python formatter (https://github.com/charliermarsh/ruff). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.18/reference/subsystems/scala-infer.mdx index 0f5579805..f3bca9b6b 100644 --- a/versioned_docs/version-2.18/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/scala.mdx b/versioned_docs/version-2.18/reference/subsystems/scala.mdx index b55c6b2ae..8184f5acf 100644 --- a/versioned_docs/version-2.18/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/scalac.mdx b/versioned_docs/version-2.18/reference/subsystems/scalac.mdx index 93dd5914c..d2ddec7ca 100644 --- a/versioned_docs/version-2.18/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.18/reference/subsystems/scalafmt.mdx index efd147aa5..854ab7ecf 100644 --- a/versioned_docs/version-2.18/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.18/reference/subsystems/scalapb.mdx index 05042d305..5ded9a476 100644 --- a/versioned_docs/version-2.18/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.18/reference/subsystems/scalatest.mdx index 871381de5..8e6047ec2 100644 --- a/versioned_docs/version-2.18/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/scc.mdx b/versioned_docs/version-2.18/reference/subsystems/scc.mdx index 7dd17695c..847d5225b 100644 --- a/versioned_docs/version-2.18/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.18/reference/subsystems/setup-py-generation.mdx index 45795af4c..753cf558b 100644 --- a/versioned_docs/version-2.18/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/setuptools-scm.mdx b/versioned_docs/version-2.18/reference/subsystems/setuptools-scm.mdx index 00b49ef21..92a606ade 100644 --- a/versioned_docs/version-2.18/reference/subsystems/setuptools-scm.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/setuptools-scm.mdx @@ -1,5 +1,7 @@ --- title: setuptools-scm +description: | + A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.18/reference/subsystems/setuptools.mdx index b743f6095..19eb5fdc9 100644 --- a/versioned_docs/version-2.18/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.18/reference/subsystems/shell-setup.mdx index 26bb6f1c9..6affb0d9b 100644 --- a/versioned_docs/version-2.18/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/shell-test.mdx b/versioned_docs/version-2.18/reference/subsystems/shell-test.mdx index 489c11311..311238694 100644 --- a/versioned_docs/version-2.18/reference/subsystems/shell-test.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/shell-test.mdx @@ -1,5 +1,7 @@ --- title: shell-test +description: | + Options for Pants' Shell test support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.18/reference/subsystems/shellcheck.mdx index d0eea4ddc..86aa41bfc 100644 --- a/versioned_docs/version-2.18/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.18/reference/subsystems/shfmt.mdx index 46d64aeea..285fd4ed7 100644 --- a/versioned_docs/version-2.18/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/shunit2.mdx b/versioned_docs/version-2.18/reference/subsystems/shunit2.mdx index 998411c46..21a25e928 100644 --- a/versioned_docs/version-2.18/reference/subsystems/shunit2.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/shunit2.mdx @@ -1,5 +1,7 @@ --- title: shunit2 +description: | + shUnit2 is a xUnit framework for Bourne based shell scripts (https://github.com/kward/shunit2) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/source.mdx b/versioned_docs/version-2.18/reference/subsystems/source.mdx index 60c40a88e..c1ffd1699 100644 --- a/versioned_docs/version-2.18/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/spectral.mdx b/versioned_docs/version-2.18/reference/subsystems/spectral.mdx index 685a7e52e..011e995fb 100644 --- a/versioned_docs/version-2.18/reference/subsystems/spectral.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/spectral.mdx @@ -1,5 +1,7 @@ --- title: spectral +description: | + A flexible JSON/YAML linter for creating automated style guides (https://github.com/stoplightio/spectral). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/stats.mdx b/versioned_docs/version-2.18/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.18/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.18/reference/subsystems/subprocess-environment.mdx index 7b93da1c0..5a8ccac94 100644 --- a/versioned_docs/version-2.18/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/terraform-fmt.mdx b/versioned_docs/version-2.18/reference/subsystems/terraform-fmt.mdx index 49bbf119b..e967d1f9c 100644 --- a/versioned_docs/version-2.18/reference/subsystems/terraform-fmt.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/terraform-hcl2-parser.mdx b/versioned_docs/version-2.18/reference/subsystems/terraform-hcl2-parser.mdx index 7dd7c8ff9..5e4a0c43a 100644 --- a/versioned_docs/version-2.18/reference/subsystems/terraform-hcl2-parser.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/terraform-validate.mdx b/versioned_docs/version-2.18/reference/subsystems/terraform-validate.mdx index edb178a87..6cb16de11 100644 --- a/versioned_docs/version-2.18/reference/subsystems/terraform-validate.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/thrift.mdx b/versioned_docs/version-2.18/reference/subsystems/thrift.mdx index 230854701..7a691f82d 100644 --- a/versioned_docs/version-2.18/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/twine.mdx b/versioned_docs/version-2.18/reference/subsystems/twine.mdx index f61c11f4d..03f9205b5 100644 --- a/versioned_docs/version-2.18/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPI and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/workunit-logger.mdx b/versioned_docs/version-2.18/reference/subsystems/workunit-logger.mdx index a33434a0e..09183ea36 100644 --- a/versioned_docs/version-2.18/reference/subsystems/workunit-logger.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/workunit-logger.mdx @@ -1,5 +1,7 @@ --- title: workunit-logger +description: | + Workunit Logger subsystem. Useful for debugging pants itself. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/yamllint.mdx b/versioned_docs/version-2.18/reference/subsystems/yamllint.mdx index 5c11119c2..2d7b8357a 100644 --- a/versioned_docs/version-2.18/reference/subsystems/yamllint.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/yamllint.mdx @@ -1,5 +1,7 @@ --- title: yamllint +description: | + A linter for YAML files (https://yamllint.readthedocs.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/subsystems/yapf.mdx b/versioned_docs/version-2.18/reference/subsystems/yapf.mdx index 5067f3d79..6c3acafef 100644 --- a/versioned_docs/version-2.18/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.18/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.18/reference/targets/adhoc_tool.mdx b/versioned_docs/version-2.18/reference/targets/adhoc_tool.mdx index 985e36caa..8b2d1dd9a 100644 --- a/versioned_docs/version-2.18/reference/targets/adhoc_tool.mdx +++ b/versioned_docs/version-2.18/reference/targets/adhoc_tool.mdx @@ -1,5 +1,7 @@ --- title: adhoc_tool +description: | + Execute any runnable target for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/archive.mdx b/versioned_docs/version-2.18/reference/targets/archive.mdx index c52c5ec85..8d9e9d646 100644 --- a/versioned_docs/version-2.18/reference/targets/archive.mdx +++ b/versioned_docs/version-2.18/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.18/reference/targets/deploy_jar.mdx index 774318363..f798f52db 100644 --- a/versioned_docs/version-2.18/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.18/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/docker_environment.mdx b/versioned_docs/version-2.18/reference/targets/docker_environment.mdx index 4ed09d62d..7c583513d 100644 --- a/versioned_docs/version-2.18/reference/targets/docker_environment.mdx +++ b/versioned_docs/version-2.18/reference/targets/docker_environment.mdx @@ -1,5 +1,7 @@ --- title: docker_environment +description: | + Configuration of a Docker environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/docker_image.mdx b/versioned_docs/version-2.18/reference/targets/docker_image.mdx index 92749aae5..4307afee9 100644 --- a/versioned_docs/version-2.18/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.18/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/experimental_test_shell_command.mdx b/versioned_docs/version-2.18/reference/targets/experimental_test_shell_command.mdx index 58eccc73a..7fbf84805 100644 --- a/versioned_docs/version-2.18/reference/targets/experimental_test_shell_command.mdx +++ b/versioned_docs/version-2.18/reference/targets/experimental_test_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_test_shell_command +description: | + Run a script as a test via the `test` goal, with all dependencies packaged/copied available in the chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_go_package_sources.mdx b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_go_package_sources.mdx index 0630639a4..b12d53c8d 100644 --- a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_go_package_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_go_package_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_go_package_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `GoPackageSourcesField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_java_sources.mdx b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_java_sources.mdx index ff3e04681..c3c6f8c4d 100644 --- a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_java_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_java_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_java_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `JavaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_kotlin_sources.mdx b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_kotlin_sources.mdx index bae3428a7..a17b55a26 100644 --- a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_kotlin_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_kotlin_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `KotlinSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_python_sources.mdx b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_python_sources.mdx index 5751ec09f..169ffa6c2 100644 --- a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_python_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_python_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_python_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `PythonSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_resources.mdx b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_resources.mdx index 7f60252a5..01b2659c6 100644 --- a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_resources.mdx +++ b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_resources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_resources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ResourceSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_scala_sources.mdx b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_scala_sources.mdx index 5548c481b..d08d758a2 100644 --- a/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_scala_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/experimental_wrap_as_scala_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_scala_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ScalaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/file.mdx b/versioned_docs/version-2.18/reference/targets/file.mdx index b814b434b..c5327b3e0 100644 --- a/versioned_docs/version-2.18/reference/targets/file.mdx +++ b/versioned_docs/version-2.18/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/files.mdx b/versioned_docs/version-2.18/reference/targets/files.mdx index 68adbc45f..107a7ca81 100644 --- a/versioned_docs/version-2.18/reference/targets/files.mdx +++ b/versioned_docs/version-2.18/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/go_binary.mdx b/versioned_docs/version-2.18/reference/targets/go_binary.mdx index e1a85a7a6..3762d6c9d 100644 --- a/versioned_docs/version-2.18/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.18/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/go_mod.mdx b/versioned_docs/version-2.18/reference/targets/go_mod.mdx index a0cfd6173..eddaa16fd 100644 --- a/versioned_docs/version-2.18/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.18/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/go_package.mdx b/versioned_docs/version-2.18/reference/targets/go_package.mdx index fbb802ab4..0f1b51616 100644 --- a/versioned_docs/version-2.18/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.18/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.18/reference/targets/go_third_party_package.mdx index f6dd9e5ee..057823bf9 100644 --- a/versioned_docs/version-2.18/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.18/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/helm_artifact.mdx b/versioned_docs/version-2.18/reference/targets/helm_artifact.mdx index df2c66974..3278b9c18 100644 --- a/versioned_docs/version-2.18/reference/targets/helm_artifact.mdx +++ b/versioned_docs/version-2.18/reference/targets/helm_artifact.mdx @@ -1,5 +1,7 @@ --- title: helm_artifact +description: | + A third party Helm artifact. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/helm_chart.mdx b/versioned_docs/version-2.18/reference/targets/helm_chart.mdx index 5a811b8c3..c645f6413 100644 --- a/versioned_docs/version-2.18/reference/targets/helm_chart.mdx +++ b/versioned_docs/version-2.18/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/helm_deployment.mdx b/versioned_docs/version-2.18/reference/targets/helm_deployment.mdx index 736bae300..980a44893 100644 --- a/versioned_docs/version-2.18/reference/targets/helm_deployment.mdx +++ b/versioned_docs/version-2.18/reference/targets/helm_deployment.mdx @@ -1,5 +1,7 @@ --- title: helm_deployment +description: | + A Helm chart deployment. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/helm_unittest_test.mdx b/versioned_docs/version-2.18/reference/targets/helm_unittest_test.mdx index d7cb4dd80..59d3857df 100644 --- a/versioned_docs/version-2.18/reference/targets/helm_unittest_test.mdx +++ b/versioned_docs/version-2.18/reference/targets/helm_unittest_test.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_test +description: | + A single helm-unittest suite file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/helm_unittest_tests.mdx b/versioned_docs/version-2.18/reference/targets/helm_unittest_tests.mdx index c994a7105..5009baabe 100644 --- a/versioned_docs/version-2.18/reference/targets/helm_unittest_tests.mdx +++ b/versioned_docs/version-2.18/reference/targets/helm_unittest_tests.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_tests +description: | + Generates a `helm_unittest_test` target per each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/java_source.mdx b/versioned_docs/version-2.18/reference/targets/java_source.mdx index 4ba82bc8b..da51ecd86 100644 --- a/versioned_docs/version-2.18/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.18/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/java_sources.mdx b/versioned_docs/version-2.18/reference/targets/java_sources.mdx index de38e0b49..6c23557ce 100644 --- a/versioned_docs/version-2.18/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/junit_test.mdx b/versioned_docs/version-2.18/reference/targets/junit_test.mdx index 85d49c629..7282fd2a0 100644 --- a/versioned_docs/version-2.18/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.18/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/junit_tests.mdx b/versioned_docs/version-2.18/reference/targets/junit_tests.mdx index ee5419530..83b9ae627 100644 --- a/versioned_docs/version-2.18/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.18/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.18/reference/targets/jvm_artifact.mdx index ead71287d..3fdb487b6 100644 --- a/versioned_docs/version-2.18/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.18/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/jvm_war.mdx b/versioned_docs/version-2.18/reference/targets/jvm_war.mdx index b949fe9d7..6681a016d 100644 --- a/versioned_docs/version-2.18/reference/targets/jvm_war.mdx +++ b/versioned_docs/version-2.18/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/kotlin_junit_test.mdx b/versioned_docs/version-2.18/reference/targets/kotlin_junit_test.mdx index 222f1f9fa..5920926cb 100644 --- a/versioned_docs/version-2.18/reference/targets/kotlin_junit_test.mdx +++ b/versioned_docs/version-2.18/reference/targets/kotlin_junit_test.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_test +description: | + A single Kotlin test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/kotlin_junit_tests.mdx b/versioned_docs/version-2.18/reference/targets/kotlin_junit_tests.mdx index 2d80d87cb..1f1b81f71 100644 --- a/versioned_docs/version-2.18/reference/targets/kotlin_junit_tests.mdx +++ b/versioned_docs/version-2.18/reference/targets/kotlin_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_tests +description: | + Generate a `kotlin_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/kotlin_source.mdx b/versioned_docs/version-2.18/reference/targets/kotlin_source.mdx index c79606ce2..40f609ad5 100644 --- a/versioned_docs/version-2.18/reference/targets/kotlin_source.mdx +++ b/versioned_docs/version-2.18/reference/targets/kotlin_source.mdx @@ -1,5 +1,7 @@ --- title: kotlin_source +description: | + A single Kotlin source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/kotlin_sources.mdx b/versioned_docs/version-2.18/reference/targets/kotlin_sources.mdx index d48edefaa..3e3eb6011 100644 --- a/versioned_docs/version-2.18/reference/targets/kotlin_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: kotlin_sources +description: | + Generate a `kotlin_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/kotlinc_plugin.mdx b/versioned_docs/version-2.18/reference/targets/kotlinc_plugin.mdx index 828754fa0..2614957de 100644 --- a/versioned_docs/version-2.18/reference/targets/kotlinc_plugin.mdx +++ b/versioned_docs/version-2.18/reference/targets/kotlinc_plugin.mdx @@ -1,5 +1,7 @@ --- title: kotlinc_plugin +description: | + A plugin for `kotlinc`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/local_environment.mdx b/versioned_docs/version-2.18/reference/targets/local_environment.mdx index 1d2e1f114..c6bd61baa 100644 --- a/versioned_docs/version-2.18/reference/targets/local_environment.mdx +++ b/versioned_docs/version-2.18/reference/targets/local_environment.mdx @@ -1,5 +1,7 @@ --- title: local_environment +description: | + Configuration of a local execution environment for specific platforms. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/openapi_document.mdx b/versioned_docs/version-2.18/reference/targets/openapi_document.mdx index 77e38957a..52348e787 100644 --- a/versioned_docs/version-2.18/reference/targets/openapi_document.mdx +++ b/versioned_docs/version-2.18/reference/targets/openapi_document.mdx @@ -1,5 +1,7 @@ --- title: openapi_document +description: | + A single OpenAPI document file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/openapi_documents.mdx b/versioned_docs/version-2.18/reference/targets/openapi_documents.mdx index 52ab7c31c..75a7ede1f 100644 --- a/versioned_docs/version-2.18/reference/targets/openapi_documents.mdx +++ b/versioned_docs/version-2.18/reference/targets/openapi_documents.mdx @@ -1,5 +1,7 @@ --- title: openapi_documents +description: | + Generate an `openapi_document` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/openapi_source.mdx b/versioned_docs/version-2.18/reference/targets/openapi_source.mdx index 91d534433..8d95b8a22 100644 --- a/versioned_docs/version-2.18/reference/targets/openapi_source.mdx +++ b/versioned_docs/version-2.18/reference/targets/openapi_source.mdx @@ -1,5 +1,7 @@ --- title: openapi_source +description: | + A single OpenAPI source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/openapi_sources.mdx b/versioned_docs/version-2.18/reference/targets/openapi_sources.mdx index 019faaf18..f7a4971e2 100644 --- a/versioned_docs/version-2.18/reference/targets/openapi_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/openapi_sources.mdx @@ -1,5 +1,7 @@ --- title: openapi_sources +description: | + Generate an `openapi_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.18/reference/targets/pants_requirements.mdx index c37aabd33..a4fddfac5 100644 --- a/versioned_docs/version-2.18/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.18/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.18/reference/targets/pex_binaries.mdx index 99892019d..fd2838553 100644 --- a/versioned_docs/version-2.18/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.18/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/pex_binary.mdx b/versioned_docs/version-2.18/reference/targets/pex_binary.mdx index e66770f79..5734485c9 100644 --- a/versioned_docs/version-2.18/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.18/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.18/reference/targets/pipenv_requirements.mdx index f67f613c7..8232eece0 100644 --- a/versioned_docs/version-2.18/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.18/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.18/reference/targets/poetry_requirements.mdx index 6edf88e02..b33cbf23b 100644 --- a/versioned_docs/version-2.18/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.18/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry `pyproject.toml`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.18/reference/targets/protobuf_source.mdx index 9de4efce8..d5a2db731 100644 --- a/versioned_docs/version-2.18/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.18/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.18/reference/targets/protobuf_sources.mdx index 08bddc240..9f15e21d9 100644 --- a/versioned_docs/version-2.18/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.18/reference/targets/pyoxidizer_binary.mdx index 559b10b7f..82acef271 100644 --- a/versioned_docs/version-2.18/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.18/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_aws_lambda_function.mdx b/versioned_docs/version-2.18/reference/targets/python_aws_lambda_function.mdx index 9d5d8d73d..a0270d69e 100644 --- a/versioned_docs/version-2.18/reference/targets/python_aws_lambda_function.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_aws_lambda_function.mdx @@ -1,5 +1,7 @@ --- title: python_aws_lambda_function +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_aws_lambda_layer.mdx b/versioned_docs/version-2.18/reference/targets/python_aws_lambda_layer.mdx index 76169e1d8..5e05bdb39 100644 --- a/versioned_docs/version-2.18/reference/targets/python_aws_lambda_layer.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_aws_lambda_layer.mdx @@ -1,5 +1,7 @@ --- title: python_aws_lambda_layer +description: | + A Python layer suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_distribution.mdx b/versioned_docs/version-2.18/reference/targets/python_distribution.mdx index 9d0608231..e9a5f924e 100644 --- a/versioned_docs/version-2.18/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.18/reference/targets/python_google_cloud_function.mdx index 2d92eec6d..f8b8115e0 100644 --- a/versioned_docs/version-2.18/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_requirement.mdx b/versioned_docs/version-2.18/reference/targets/python_requirement.mdx index 014355c28..23c756f24 100644 --- a/versioned_docs/version-2.18/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_requirements.mdx b/versioned_docs/version-2.18/reference/targets/python_requirements.mdx index b4078a301..a891310f2 100644 --- a/versioned_docs/version-2.18/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style or PEP 621 compliant `pyproject.toml` file. The choice of parser for the `source` field is determined by the file name. If the `source` field ends with `pyproject.toml`, then the file is assumed to be a PEP 621 compliant file. Any other file name uses the requirements.txt-style parser. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_source.mdx b/versioned_docs/version-2.18/reference/targets/python_source.mdx index 6b2904fb1..c021f5287 100644 --- a/versioned_docs/version-2.18/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_sources.mdx b/versioned_docs/version-2.18/reference/targets/python_sources.mdx index 40f0a86d8..36c759a3a 100644 --- a/versioned_docs/version-2.18/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_test.mdx b/versioned_docs/version-2.18/reference/targets/python_test.mdx index f8bd1fb73..a86507f3a 100644 --- a/versioned_docs/version-2.18/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.18/reference/targets/python_test_utils.mdx index 3e123cf34..a109515e1 100644 --- a/versioned_docs/version-2.18/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/python_tests.mdx b/versioned_docs/version-2.18/reference/targets/python_tests.mdx index f43e78553..f1fd799b6 100644 --- a/versioned_docs/version-2.18/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.18/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/relocated_files.mdx b/versioned_docs/version-2.18/reference/targets/relocated_files.mdx index 346339e69..9efc94ea5 100644 --- a/versioned_docs/version-2.18/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.18/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/remote_environment.mdx b/versioned_docs/version-2.18/reference/targets/remote_environment.mdx index 5ecb7d127..693ad4d90 100644 --- a/versioned_docs/version-2.18/reference/targets/remote_environment.mdx +++ b/versioned_docs/version-2.18/reference/targets/remote_environment.mdx @@ -1,5 +1,7 @@ --- title: remote_environment +description: | + Configuration of a remote execution environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/resource.mdx b/versioned_docs/version-2.18/reference/targets/resource.mdx index 8573949b0..816be36ee 100644 --- a/versioned_docs/version-2.18/reference/targets/resource.mdx +++ b/versioned_docs/version-2.18/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/resources.mdx b/versioned_docs/version-2.18/reference/targets/resources.mdx index 4bab2b636..c75c6c3e0 100644 --- a/versioned_docs/version-2.18/reference/targets/resources.mdx +++ b/versioned_docs/version-2.18/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/run_shell_command.mdx b/versioned_docs/version-2.18/reference/targets/run_shell_command.mdx index bf8dfe79c..e705072a2 100644 --- a/versioned_docs/version-2.18/reference/targets/run_shell_command.mdx +++ b/versioned_docs/version-2.18/reference/targets/run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/scala_artifact.mdx b/versioned_docs/version-2.18/reference/targets/scala_artifact.mdx index 2bea85779..0195933c3 100644 --- a/versioned_docs/version-2.18/reference/targets/scala_artifact.mdx +++ b/versioned_docs/version-2.18/reference/targets/scala_artifact.mdx @@ -1,5 +1,7 @@ --- title: scala_artifact +description: | + A third-party Scala artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.18/reference/targets/scala_junit_test.mdx index 4435e1f2c..6763f940b 100644 --- a/versioned_docs/version-2.18/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.18/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.18/reference/targets/scala_junit_tests.mdx index e0a6b8fa3..6ccdc8665 100644 --- a/versioned_docs/version-2.18/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.18/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/scala_source.mdx b/versioned_docs/version-2.18/reference/targets/scala_source.mdx index 9a1c6e5c6..0dbb38fdb 100644 --- a/versioned_docs/version-2.18/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.18/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/scala_sources.mdx b/versioned_docs/version-2.18/reference/targets/scala_sources.mdx index d61b675d0..fe3ea39f8 100644 --- a/versioned_docs/version-2.18/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.18/reference/targets/scalac_plugin.mdx index 5debfdf3a..d6596589c 100644 --- a/versioned_docs/version-2.18/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.18/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.18/reference/targets/scalatest_test.mdx index d16770489..62e6b59c0 100644 --- a/versioned_docs/version-2.18/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.18/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.18/reference/targets/scalatest_tests.mdx index d9f116bcd..1a1a2a148 100644 --- a/versioned_docs/version-2.18/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.18/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching `('*Spec.scala', '*Suite.scala')`). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/shell_command.mdx b/versioned_docs/version-2.18/reference/targets/shell_command.mdx index 507f27c3c..cf50a07ed 100644 --- a/versioned_docs/version-2.18/reference/targets/shell_command.mdx +++ b/versioned_docs/version-2.18/reference/targets/shell_command.mdx @@ -1,5 +1,7 @@ --- title: shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/shell_source.mdx b/versioned_docs/version-2.18/reference/targets/shell_source.mdx index 4b901cc57..e22558bf2 100644 --- a/versioned_docs/version-2.18/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.18/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/shell_sources.mdx b/versioned_docs/version-2.18/reference/targets/shell_sources.mdx index a8604d467..9cfa43a57 100644 --- a/versioned_docs/version-2.18/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.18/reference/targets/shunit2_test.mdx index 423986ddf..833e67d7a 100644 --- a/versioned_docs/version-2.18/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.18/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.18/reference/targets/shunit2_tests.mdx index 0d2b385ff..f1d0a13c7 100644 --- a/versioned_docs/version-2.18/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.18/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/system_binary.mdx b/versioned_docs/version-2.18/reference/targets/system_binary.mdx index d7bd775a0..017c61020 100644 --- a/versioned_docs/version-2.18/reference/targets/system_binary.mdx +++ b/versioned_docs/version-2.18/reference/targets/system_binary.mdx @@ -1,5 +1,7 @@ --- title: system_binary +description: | + A system binary that can be run with `pants run` or consumed by `adhoc_tool`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/target.mdx b/versioned_docs/version-2.18/reference/targets/target.mdx index 0daebe015..439142539 100644 --- a/versioned_docs/version-2.18/reference/targets/target.mdx +++ b/versioned_docs/version-2.18/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/terraform_deployment.mdx b/versioned_docs/version-2.18/reference/targets/terraform_deployment.mdx index 8a0324a13..77f2c585c 100644 --- a/versioned_docs/version-2.18/reference/targets/terraform_deployment.mdx +++ b/versioned_docs/version-2.18/reference/targets/terraform_deployment.mdx @@ -1,5 +1,7 @@ --- title: terraform_deployment +description: | + A deployment of Terraform --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/terraform_module.mdx b/versioned_docs/version-2.18/reference/targets/terraform_module.mdx index 5d4192fb2..1d8f523f0 100644 --- a/versioned_docs/version-2.18/reference/targets/terraform_module.mdx +++ b/versioned_docs/version-2.18/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/thrift_source.mdx b/versioned_docs/version-2.18/reference/targets/thrift_source.mdx index 98e2b349b..f0e993666 100644 --- a/versioned_docs/version-2.18/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.18/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.18/reference/targets/thrift_sources.mdx index 598b6f430..50aaf74c7 100644 --- a/versioned_docs/version-2.18/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.18/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.18/reference/targets/vcs_version.mdx b/versioned_docs/version-2.18/reference/targets/vcs_version.mdx index 421691958..93e0a1526 100644 --- a/versioned_docs/version-2.18/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.18/reference/targets/vcs_version.mdx @@ -1,5 +1,7 @@ --- title: vcs_version +description: | + Generates a version string from VCS state. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/global-options.mdx b/versioned_docs/version-2.19/reference/global-options.mdx index 0a72276c6..52adf618a 100644 --- a/versioned_docs/version-2.19/reference/global-options.mdx +++ b/versioned_docs/version-2.19/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/check.mdx b/versioned_docs/version-2.19/reference/goals/check.mdx index 055b4584b..d2b292a1c 100644 --- a/versioned_docs/version-2.19/reference/goals/check.mdx +++ b/versioned_docs/version-2.19/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/count-loc.mdx b/versioned_docs/version-2.19/reference/goals/count-loc.mdx index 4fc845fc8..a16c906d6 100644 --- a/versioned_docs/version-2.19/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.19/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/dependees.mdx b/versioned_docs/version-2.19/reference/goals/dependees.mdx index c8d158961..4033c80d2 100644 --- a/versioned_docs/version-2.19/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.19/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/dependencies.mdx b/versioned_docs/version-2.19/reference/goals/dependencies.mdx index eecf7ea2a..4d03fb731 100644 --- a/versioned_docs/version-2.19/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.19/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/dependents.mdx b/versioned_docs/version-2.19/reference/goals/dependents.mdx index d8f395668..6727ab393 100644 --- a/versioned_docs/version-2.19/reference/goals/dependents.mdx +++ b/versioned_docs/version-2.19/reference/goals/dependents.mdx @@ -1,5 +1,7 @@ --- title: dependents +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/experimental-bsp.mdx b/versioned_docs/version-2.19/reference/goals/experimental-bsp.mdx index 6ffa7f417..fcc748c92 100644 --- a/versioned_docs/version-2.19/reference/goals/experimental-bsp.mdx +++ b/versioned_docs/version-2.19/reference/goals/experimental-bsp.mdx @@ -1,5 +1,7 @@ --- title: experimental-bsp +description: | + Setup repository for Build Server Protocol (https://build-server-protocol.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/experimental-deploy.mdx b/versioned_docs/version-2.19/reference/goals/experimental-deploy.mdx index cedddbdf4..f437c6091 100644 --- a/versioned_docs/version-2.19/reference/goals/experimental-deploy.mdx +++ b/versioned_docs/version-2.19/reference/goals/experimental-deploy.mdx @@ -1,5 +1,7 @@ --- title: experimental-deploy +description: | + Perform a deployment process. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/experimental-explorer.mdx b/versioned_docs/version-2.19/reference/goals/experimental-explorer.mdx index eb5e42352..7df90e7dc 100644 --- a/versioned_docs/version-2.19/reference/goals/experimental-explorer.mdx +++ b/versioned_docs/version-2.19/reference/goals/experimental-explorer.mdx @@ -1,5 +1,7 @@ --- title: experimental-explorer +description: | + Run the Pants Explorer Web UI server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/export-codegen.mdx b/versioned_docs/version-2.19/reference/goals/export-codegen.mdx index 08f5cb08d..5ba91e387 100644 --- a/versioned_docs/version-2.19/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.19/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/export.mdx b/versioned_docs/version-2.19/reference/goals/export.mdx index bfb217a60..40e2c181a 100644 --- a/versioned_docs/version-2.19/reference/goals/export.mdx +++ b/versioned_docs/version-2.19/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/filedeps.mdx b/versioned_docs/version-2.19/reference/goals/filedeps.mdx index fadeb17a0..ea3763879 100644 --- a/versioned_docs/version-2.19/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.19/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/fix.mdx b/versioned_docs/version-2.19/reference/goals/fix.mdx index e06700269..46c842554 100644 --- a/versioned_docs/version-2.19/reference/goals/fix.mdx +++ b/versioned_docs/version-2.19/reference/goals/fix.mdx @@ -1,5 +1,7 @@ --- title: fix +description: | + Autofix source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/fmt.mdx b/versioned_docs/version-2.19/reference/goals/fmt.mdx index d9fa4f94b..35b8eef6b 100644 --- a/versioned_docs/version-2.19/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.19/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.19/reference/goals/generate-lockfiles.mdx index 823ef51d6..d4bf5064f 100644 --- a/versioned_docs/version-2.19/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.19/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/generate-snapshots.mdx b/versioned_docs/version-2.19/reference/goals/generate-snapshots.mdx index d10694ebc..5eb68d024 100644 --- a/versioned_docs/version-2.19/reference/goals/generate-snapshots.mdx +++ b/versioned_docs/version-2.19/reference/goals/generate-snapshots.mdx @@ -1,5 +1,7 @@ --- title: generate-snapshots +description: | + Generate test snapshots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/go-generate.mdx b/versioned_docs/version-2.19/reference/goals/go-generate.mdx index 68d198bbe..452041d13 100644 --- a/versioned_docs/version-2.19/reference/goals/go-generate.mdx +++ b/versioned_docs/version-2.19/reference/goals/go-generate.mdx @@ -1,5 +1,7 @@ --- title: go-generate +description: | + Run each command in a package described by a `//go:generate` directive. This is equivalent to running `go generate` on a Go package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/help-advanced.mdx b/versioned_docs/version-2.19/reference/goals/help-advanced.mdx index 977180fd5..30aa0b0e5 100644 --- a/versioned_docs/version-2.19/reference/goals/help-advanced.mdx +++ b/versioned_docs/version-2.19/reference/goals/help-advanced.mdx @@ -1,5 +1,7 @@ --- title: help-advanced +description: | + Help for advanced options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/help-all.mdx b/versioned_docs/version-2.19/reference/goals/help-all.mdx index d50060ead..d62b68315 100644 --- a/versioned_docs/version-2.19/reference/goals/help-all.mdx +++ b/versioned_docs/version-2.19/reference/goals/help-all.mdx @@ -1,5 +1,7 @@ --- title: help-all +description: | + Print a JSON object containing all help info. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/help.mdx b/versioned_docs/version-2.19/reference/goals/help.mdx index 179646022..1a54fc2d3 100644 --- a/versioned_docs/version-2.19/reference/goals/help.mdx +++ b/versioned_docs/version-2.19/reference/goals/help.mdx @@ -1,5 +1,7 @@ --- title: help +description: | + Display usage message. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/lint.mdx b/versioned_docs/version-2.19/reference/goals/lint.mdx index 47aee7528..d33ccb3e6 100644 --- a/versioned_docs/version-2.19/reference/goals/lint.mdx +++ b/versioned_docs/version-2.19/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run linters/formatters/fixers in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/list.mdx b/versioned_docs/version-2.19/reference/goals/list.mdx index 78d49bb55..bc858f973 100644 --- a/versioned_docs/version-2.19/reference/goals/list.mdx +++ b/versioned_docs/version-2.19/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/package.mdx b/versioned_docs/version-2.19/reference/goals/package.mdx index 357be63d3..e6cb234d7 100644 --- a/versioned_docs/version-2.19/reference/goals/package.mdx +++ b/versioned_docs/version-2.19/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/paths.mdx b/versioned_docs/version-2.19/reference/goals/paths.mdx index 6ada5cf63..a2910f8b2 100644 --- a/versioned_docs/version-2.19/reference/goals/paths.mdx +++ b/versioned_docs/version-2.19/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. Either address may represent a group of targets, e.g. `--from=src/app/main.py --to=src/library::`. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/peek.mdx b/versioned_docs/version-2.19/reference/goals/peek.mdx index f42185cf3..4c54e6307 100644 --- a/versioned_docs/version-2.19/reference/goals/peek.mdx +++ b/versioned_docs/version-2.19/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/publish.mdx b/versioned_docs/version-2.19/reference/goals/publish.mdx index b6e9c59c8..2a90b4bd6 100644 --- a/versioned_docs/version-2.19/reference/goals/publish.mdx +++ b/versioned_docs/version-2.19/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/py-constraints.mdx b/versioned_docs/version-2.19/reference/goals/py-constraints.mdx index 21a5bf3a8..7c779befd 100644 --- a/versioned_docs/version-2.19/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.19/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/python-dump-source-analysis.mdx b/versioned_docs/version-2.19/reference/goals/python-dump-source-analysis.mdx index 7ca46e697..ee1fc3552 100644 --- a/versioned_docs/version-2.19/reference/goals/python-dump-source-analysis.mdx +++ b/versioned_docs/version-2.19/reference/goals/python-dump-source-analysis.mdx @@ -1,5 +1,7 @@ --- title: python-dump-source-analysis +description: | + Dump source analysis for python_source targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/repl.mdx b/versioned_docs/version-2.19/reference/goals/repl.mdx index b2ecb84f1..4e438dda9 100644 --- a/versioned_docs/version-2.19/reference/goals/repl.mdx +++ b/versioned_docs/version-2.19/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/roots.mdx b/versioned_docs/version-2.19/reference/goals/roots.mdx index b5fcc9fe4..6c3dfe8a2 100644 --- a/versioned_docs/version-2.19/reference/goals/roots.mdx +++ b/versioned_docs/version-2.19/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/run.mdx b/versioned_docs/version-2.19/reference/goals/run.mdx index 4a26d2e66..0a3c0375e 100644 --- a/versioned_docs/version-2.19/reference/goals/run.mdx +++ b/versioned_docs/version-2.19/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/tailor.mdx b/versioned_docs/version-2.19/reference/goals/tailor.mdx index 8bfb3569d..749555080 100644 --- a/versioned_docs/version-2.19/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.19/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/test.mdx b/versioned_docs/version-2.19/reference/goals/test.mdx index 2586d30f2..2e5d3f6b2 100644 --- a/versioned_docs/version-2.19/reference/goals/test.mdx +++ b/versioned_docs/version-2.19/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/update-build-files.mdx b/versioned_docs/version-2.19/reference/goals/update-build-files.mdx index 14a8b6330..ce05ccfbc 100644 --- a/versioned_docs/version-2.19/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.19/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/goals/version.mdx b/versioned_docs/version-2.19/reference/goals/version.mdx index a54efa055..1867771d1 100644 --- a/versioned_docs/version-2.19/reference/goals/version.mdx +++ b/versioned_docs/version-2.19/reference/goals/version.mdx @@ -1,5 +1,7 @@ --- title: version +description: | + Display Pants version. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/add-trailing-comma.mdx b/versioned_docs/version-2.19/reference/subsystems/add-trailing-comma.mdx index 453607e16..f080283e5 100644 --- a/versioned_docs/version-2.19/reference/subsystems/add-trailing-comma.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/add-trailing-comma.mdx @@ -1,5 +1,7 @@ --- title: add-trailing-comma +description: | + The add-trailing-comma Python code formatter (https://github.com/asottile/add-trailing-comma). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.19/reference/subsystems/anonymous-telemetry.mdx index db6cfb3b8..98fcfd36a 100644 --- a/versioned_docs/version-2.19/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/apache-thrift.mdx b/versioned_docs/version-2.19/reference/subsystems/apache-thrift.mdx index 8cd006a9a..ebd400bea 100644 --- a/versioned_docs/version-2.19/reference/subsystems/apache-thrift.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/apache-thrift.mdx @@ -1,5 +1,7 @@ --- title: apache-thrift +description: | + Apache Thrift IDL compiler (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.19/reference/subsystems/autoflake.mdx index 406e3739d..e9ca05dcd 100644 --- a/versioned_docs/version-2.19/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/bandit.mdx b/versioned_docs/version-2.19/reference/subsystems/bandit.mdx index 5e69f5aa3..a2bdc83e1 100644 --- a/versioned_docs/version-2.19/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/black.mdx b/versioned_docs/version-2.19/reference/subsystems/black.mdx index c7c215a62..cfc208a50 100644 --- a/versioned_docs/version-2.19/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/buf.mdx b/versioned_docs/version-2.19/reference/subsystems/buf.mdx index 69beafca3..0ce66b600 100644 --- a/versioned_docs/version-2.19/reference/subsystems/buf.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/buf.mdx @@ -1,5 +1,7 @@ --- title: buf +description: | + A linter and formatter for Protocol Buffers (https://github.com/bufbuild/buf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/build-deprecations-fixer.mdx b/versioned_docs/version-2.19/reference/subsystems/build-deprecations-fixer.mdx index 0f9b51fe4..0f9f27cf9 100644 --- a/versioned_docs/version-2.19/reference/subsystems/build-deprecations-fixer.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/build-deprecations-fixer.mdx @@ -1,5 +1,7 @@ --- title: build-deprecations-fixer +description: | + A tool/plugin for fixing BUILD file deprecations (where possible). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/buildifier.mdx b/versioned_docs/version-2.19/reference/subsystems/buildifier.mdx index 208142fae..b90f34fe0 100644 --- a/versioned_docs/version-2.19/reference/subsystems/buildifier.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/buildifier.mdx @@ -1,5 +1,7 @@ --- title: buildifier +description: | + Buildifier is a tool for formatting BUILD files with a standard convention. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/changed.mdx b/versioned_docs/version-2.19/reference/subsystems/changed.mdx index d036fbb34..e71c161ec 100644 --- a/versioned_docs/version-2.19/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/cli.mdx b/versioned_docs/version-2.19/reference/subsystems/cli.mdx index 7a12ca8ca..c1d3d782d 100644 --- a/versioned_docs/version-2.19/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/coursier.mdx b/versioned_docs/version-2.19/reference/subsystems/coursier.mdx index e7e29b7df..b16c0865f 100644 --- a/versioned_docs/version-2.19/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. (https://get-coursier.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.19/reference/subsystems/coverage-py.mdx index d958df602..7feeea060 100644 --- a/versioned_docs/version-2.19/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/debug-adapter.mdx b/versioned_docs/version-2.19/reference/subsystems/debug-adapter.mdx index d15f05658..655c51060 100644 --- a/versioned_docs/version-2.19/reference/subsystems/debug-adapter.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/debug-adapter.mdx @@ -1,5 +1,7 @@ --- title: debug-adapter +description: | + Options used to configure and launch a Debug Adapter server. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/debugpy.mdx b/versioned_docs/version-2.19/reference/subsystems/debugpy.mdx index 79713509d..b59cea90b 100644 --- a/versioned_docs/version-2.19/reference/subsystems/debugpy.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/debugpy.mdx @@ -1,5 +1,7 @@ --- title: debugpy +description: | + An implementation of the Debug Adapter Protocol for Python (https://github.com/microsoft/debugpy). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.19/reference/subsystems/docformatter.mdx index 603b8852f..31b12a77c 100644 --- a/versioned_docs/version-2.19/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/docker.mdx b/versioned_docs/version-2.19/reference/subsystems/docker.mdx index 4b6591a46..008a63b72 100644 --- a/versioned_docs/version-2.19/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.19/reference/subsystems/dockerfile-parser.mdx index caa10b8c1..93e31ccec 100644 --- a/versioned_docs/version-2.19/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/download-terraform.mdx b/versioned_docs/version-2.19/reference/subsystems/download-terraform.mdx index 716c62a05..02962bbb8 100644 --- a/versioned_docs/version-2.19/reference/subsystems/download-terraform.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/download-terraform.mdx @@ -1,5 +1,7 @@ --- title: download-terraform +description: | + Terraform (https://terraform.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/environments-preview.mdx b/versioned_docs/version-2.19/reference/subsystems/environments-preview.mdx index 780bc8363..8231798c1 100644 --- a/versioned_docs/version-2.19/reference/subsystems/environments-preview.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/environments-preview.mdx @@ -1,5 +1,7 @@ --- title: environments-preview +description: | + A highly experimental subsystem to allow setting environment variables and executable search paths for different environments, e.g. macOS vs. Linux. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/filter.mdx b/versioned_docs/version-2.19/reference/subsystems/filter.mdx index 2a6c4cef6..490732a64 100644 --- a/versioned_docs/version-2.19/reference/subsystems/filter.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/flake8.mdx b/versioned_docs/version-2.19/reference/subsystems/flake8.mdx index 3ff4a0ea3..43b8fc4b3 100644 --- a/versioned_docs/version-2.19/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/go-test.mdx b/versioned_docs/version-2.19/reference/subsystems/go-test.mdx index 9f356582a..1e6939a1c 100644 --- a/versioned_docs/version-2.19/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.19/reference/subsystems/gofmt.mdx index 83a3eb9a5..e54bcdc75 100644 --- a/versioned_docs/version-2.19/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/golang.mdx b/versioned_docs/version-2.19/reference/subsystems/golang.mdx index 743947589..b9fd30c5f 100644 --- a/versioned_docs/version-2.19/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.19/reference/subsystems/google-java-format.mdx index 4786633ae..b8de96f17 100644 --- a/versioned_docs/version-2.19/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.19/reference/subsystems/grpc-python-plugin.mdx index b8f0ec254..0031afbe9 100644 --- a/versioned_docs/version-2.19/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.19/reference/subsystems/hadolint.mdx index 2677556e5..58490bc75 100644 --- a/versioned_docs/version-2.19/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/helm-k8s-parser.mdx b/versioned_docs/version-2.19/reference/subsystems/helm-k8s-parser.mdx index 47a222bc4..b450bdb2f 100644 --- a/versioned_docs/version-2.19/reference/subsystems/helm-k8s-parser.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/helm-k8s-parser.mdx @@ -1,5 +1,7 @@ --- title: helm-k8s-parser +description: | + Analyses K8S manifests rendered by Helm. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/helm-post-renderer.mdx b/versioned_docs/version-2.19/reference/subsystems/helm-post-renderer.mdx index 2f87c0b53..7c5435bad 100644 --- a/versioned_docs/version-2.19/reference/subsystems/helm-post-renderer.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/helm-post-renderer.mdx @@ -1,5 +1,7 @@ --- title: helm-post-renderer +description: | + Used perform modifications to the final output produced by Helm charts when they've been fully rendered. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/helm-unittest.mdx b/versioned_docs/version-2.19/reference/subsystems/helm-unittest.mdx index 77810b951..c161a0946 100644 --- a/versioned_docs/version-2.19/reference/subsystems/helm-unittest.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/helm-unittest.mdx @@ -1,5 +1,7 @@ --- title: helm-unittest +description: | + BDD styled unit test framework for Kubernetes Helm charts as a Helm plugin. (https://github.com/helm-unittest) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/helm.mdx b/versioned_docs/version-2.19/reference/subsystems/helm.mdx index 437a1a41f..7903e3d3b 100644 --- a/versioned_docs/version-2.19/reference/subsystems/helm.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/helm.mdx @@ -1,5 +1,7 @@ --- title: helm +description: | + The Helm command line (https://helm.sh) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/ipython.mdx b/versioned_docs/version-2.19/reference/subsystems/ipython.mdx index b8a9d204a..07b0c47eb 100644 --- a/versioned_docs/version-2.19/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/isort.mdx b/versioned_docs/version-2.19/reference/subsystems/isort.mdx index 64a9a6013..44d9b20d3 100644 --- a/versioned_docs/version-2.19/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/jarjar.mdx b/versioned_docs/version-2.19/reference/subsystems/jarjar.mdx index bd1e4f9c9..7491ec7f5 100644 --- a/versioned_docs/version-2.19/reference/subsystems/jarjar.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/jarjar.mdx @@ -1,5 +1,7 @@ --- title: jarjar +description: | + The Jar Jar Abrams tool (https://github.com/eed3si9n/jarjar-abrams) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.19/reference/subsystems/java-infer.mdx index 9b365727f..2088e9ff2 100644 --- a/versioned_docs/version-2.19/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/javac.mdx b/versioned_docs/version-2.19/reference/subsystems/javac.mdx index 32f80db89..a7ac13086 100644 --- a/versioned_docs/version-2.19/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/junit.mdx b/versioned_docs/version-2.19/reference/subsystems/junit.mdx index 20cedf91b..381a85fbc 100644 --- a/versioned_docs/version-2.19/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/jvm.mdx b/versioned_docs/version-2.19/reference/subsystems/jvm.mdx index 20f80de22..4cee79248 100644 --- a/versioned_docs/version-2.19/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/kotlin-infer.mdx b/versioned_docs/version-2.19/reference/subsystems/kotlin-infer.mdx index 1241c712c..89eb838c9 100644 --- a/versioned_docs/version-2.19/reference/subsystems/kotlin-infer.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/kotlin-infer.mdx @@ -1,5 +1,7 @@ --- title: kotlin-infer +description: | + Options controlling which dependencies will be inferred for Kotlin targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/kotlin.mdx b/versioned_docs/version-2.19/reference/subsystems/kotlin.mdx index 25b150315..50785c245 100644 --- a/versioned_docs/version-2.19/reference/subsystems/kotlin.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/kotlin.mdx @@ -1,5 +1,7 @@ --- title: kotlin +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/kotlinc.mdx b/versioned_docs/version-2.19/reference/subsystems/kotlinc.mdx index 428423319..3c9d68d40 100644 --- a/versioned_docs/version-2.19/reference/subsystems/kotlinc.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/kotlinc.mdx @@ -1,5 +1,7 @@ --- title: kotlinc +description: | + The Kotlin programming language (https://kotlinlang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.19/reference/subsystems/ktlint.mdx index aeb85dd01..50c5eadfa 100644 --- a/versioned_docs/version-2.19/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/ktlint.mdx @@ -1,5 +1,7 @@ --- title: ktlint +description: | + Ktlint, the anti-bikeshedding Kotlin linter with built-in formatter (https://ktlint.github.io/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.19/reference/subsystems/mypy-protobuf.mdx index b02702965..a06894b01 100644 --- a/versioned_docs/version-2.19/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/mypy.mdx b/versioned_docs/version-2.19/reference/subsystems/mypy.mdx index b58330836..5b526593c 100644 --- a/versioned_docs/version-2.19/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/nodejs-infer.mdx b/versioned_docs/version-2.19/reference/subsystems/nodejs-infer.mdx index ce0f1a9c9..2c3454f99 100644 --- a/versioned_docs/version-2.19/reference/subsystems/nodejs-infer.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/nodejs-infer.mdx @@ -1,5 +1,7 @@ --- title: nodejs-infer +description: | + Options controlling which dependencies will be inferred for javascript targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/nodejs.mdx b/versioned_docs/version-2.19/reference/subsystems/nodejs.mdx index 5064c4e84..a942ac47d 100644 --- a/versioned_docs/version-2.19/reference/subsystems/nodejs.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/nodejs.mdx @@ -1,5 +1,7 @@ --- title: nodejs +description: | + The Node.js Javascript runtime (including Corepack). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/openapi-format.mdx b/versioned_docs/version-2.19/reference/subsystems/openapi-format.mdx index 9e982c54e..d50430d7c 100644 --- a/versioned_docs/version-2.19/reference/subsystems/openapi-format.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/openapi-format.mdx @@ -1,5 +1,7 @@ --- title: openapi-format +description: | + Format an OpenAPI document by ordering, formatting and filtering fields (https://github.com/thim81/openapi-format). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/openapi.mdx b/versioned_docs/version-2.19/reference/subsystems/openapi.mdx index e1bf02a46..78c72dfbc 100644 --- a/versioned_docs/version-2.19/reference/subsystems/openapi.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/openapi.mdx @@ -1,5 +1,7 @@ --- title: openapi +description: | + The OpenAPI Specification (https://swagger.io/specification/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.19/reference/subsystems/pex-binary-defaults.mdx index 3f448d219..ed09621fb 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/pex-cli.mdx b/versioned_docs/version-2.19/reference/subsystems/pex-cli.mdx index ce9b74652..04317db5c 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pex-cli.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pex-cli.mdx @@ -1,5 +1,7 @@ --- title: pex-cli +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/pex.mdx b/versioned_docs/version-2.19/reference/subsystems/pex.mdx index 6562ee0d6..368a1dc0d 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/preamble.mdx b/versioned_docs/version-2.19/reference/subsystems/preamble.mdx index 114f378e0..dcb1e80f0 100644 --- a/versioned_docs/version-2.19/reference/subsystems/preamble.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/preamble.mdx @@ -1,5 +1,7 @@ --- title: preamble +description: | + Formats files with a preamble, with the preamble looked up based on path. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.19/reference/subsystems/protobuf-java-grpc.mdx index 7670012b6..1720fba25 100644 --- a/versioned_docs/version-2.19/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/protobuf-java-grpc.mdx @@ -1,5 +1,7 @@ --- title: protobuf-java-grpc +description: | + gRPC support for Java Protobuf (https://github.com/grpc/grpc-java) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/protoc.mdx b/versioned_docs/version-2.19/reference/subsystems/protoc.mdx index d506f75c5..8c9e87092 100644 --- a/versioned_docs/version-2.19/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/pydocstyle.mdx b/versioned_docs/version-2.19/reference/subsystems/pydocstyle.mdx index bdf23b6e1..1ebef6e92 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pydocstyle.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pydocstyle.mdx @@ -1,5 +1,7 @@ --- title: pydocstyle +description: | + A tool for checking compliance with Python docstring conventions (http://www.pydocstyle.org/en/stable/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/pylint.mdx b/versioned_docs/version-2.19/reference/subsystems/pylint.mdx index 685d669a9..832666993 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/pyoxidizer.mdx b/versioned_docs/version-2.19/reference/subsystems/pyoxidizer.mdx index ed377fa43..025326ae0 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pyoxidizer.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pyoxidizer.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer +description: | + The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/pytest.mdx b/versioned_docs/version-2.19/reference/subsystems/pytest.mdx index cbbdd6858..bec919a59 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.19/reference/subsystems/python-bootstrap.mdx index 045e049fa..c8b39b6a7 100644 --- a/versioned_docs/version-2.19/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.19/reference/subsystems/python-infer.mdx index ab4e8adea..b8c07ad43 100644 --- a/versioned_docs/version-2.19/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.19/reference/subsystems/python-native-code.mdx index 766ddeedb..dfdb91103 100644 --- a/versioned_docs/version-2.19/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.19/reference/subsystems/python-protobuf.mdx index ae52e97fc..8ca8818af 100644 --- a/versioned_docs/version-2.19/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.19/reference/subsystems/python-repos.mdx index eab70e9c6..ce2144677 100644 --- a/versioned_docs/version-2.19/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/python-thrift.mdx b/versioned_docs/version-2.19/reference/subsystems/python-thrift.mdx index 2bb418d24..3064c8512 100644 --- a/versioned_docs/version-2.19/reference/subsystems/python-thrift.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/python-thrift.mdx @@ -1,5 +1,7 @@ --- title: python-thrift +description: | + Options specific to generating Python from Thrift using Apache Thrift --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/python.mdx b/versioned_docs/version-2.19/reference/subsystems/python.mdx index 6b3bd08f0..208351ec3 100644 --- a/versioned_docs/version-2.19/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/pytype.mdx b/versioned_docs/version-2.19/reference/subsystems/pytype.mdx index ba2b07f81..f35082a81 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pytype.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pytype.mdx @@ -1,5 +1,7 @@ --- title: pytype +description: | + The Pytype utility for typechecking Python code (https://github.com/google/pytype). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.19/reference/subsystems/pyupgrade.mdx index 8306006ce..595b14c6d 100644 --- a/versioned_docs/version-2.19/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/regex-lint.mdx b/versioned_docs/version-2.19/reference/subsystems/regex-lint.mdx index 34376a064..0ae838c11 100644 --- a/versioned_docs/version-2.19/reference/subsystems/regex-lint.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/regex-lint.mdx @@ -1,5 +1,7 @@ --- title: regex-lint +description: | + Lint your code using regex patterns, e.g. to check for copyright headers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/ruff.mdx b/versioned_docs/version-2.19/reference/subsystems/ruff.mdx index 094f01ec1..575a2197c 100644 --- a/versioned_docs/version-2.19/reference/subsystems/ruff.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/ruff.mdx @@ -1,5 +1,7 @@ --- title: ruff +description: | + The Ruff Python formatter (https://github.com/charliermarsh/ruff). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.19/reference/subsystems/scala-infer.mdx index 0f5579805..f3bca9b6b 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/scala.mdx b/versioned_docs/version-2.19/reference/subsystems/scala.mdx index b55c6b2ae..8184f5acf 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/scalac.mdx b/versioned_docs/version-2.19/reference/subsystems/scalac.mdx index 93dd5914c..d2ddec7ca 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.19/reference/subsystems/scalafmt.mdx index 879d512d6..cd8edf912 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.19/reference/subsystems/scalapb.mdx index 79808f6b8..5d2c92b5c 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scalapb.mdx @@ -1,5 +1,7 @@ --- title: scalapb +description: | + The ScalaPB protocol buffer compiler (https://scalapb.github.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.19/reference/subsystems/scalatest.mdx index 1a835abda..9476aa8c3 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/scc.mdx b/versioned_docs/version-2.19/reference/subsystems/scc.mdx index 9d092ceed..2440bd129 100644 --- a/versioned_docs/version-2.19/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/semgrep.mdx b/versioned_docs/version-2.19/reference/subsystems/semgrep.mdx index ec76750f3..7b7e87fdb 100644 --- a/versioned_docs/version-2.19/reference/subsystems/semgrep.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/semgrep.mdx @@ -1,5 +1,7 @@ --- title: semgrep +description: | + Lightweight static analysis for many languages. Find bug variants with patterns that look like source code. (https://semgrep.dev/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.19/reference/subsystems/setup-py-generation.mdx index 45795af4c..753cf558b 100644 --- a/versioned_docs/version-2.19/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/setuptools-scm.mdx b/versioned_docs/version-2.19/reference/subsystems/setuptools-scm.mdx index 8817d7031..74bada381 100644 --- a/versioned_docs/version-2.19/reference/subsystems/setuptools-scm.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/setuptools-scm.mdx @@ -1,5 +1,7 @@ --- title: setuptools-scm +description: | + A tool for generating versions from VCS metadata (https://github.com/pypa/setuptools_scm). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.19/reference/subsystems/setuptools.mdx index 337b05de6..b0d746752 100644 --- a/versioned_docs/version-2.19/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.19/reference/subsystems/shell-setup.mdx index 26bb6f1c9..6affb0d9b 100644 --- a/versioned_docs/version-2.19/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/shell-test.mdx b/versioned_docs/version-2.19/reference/subsystems/shell-test.mdx index 489c11311..311238694 100644 --- a/versioned_docs/version-2.19/reference/subsystems/shell-test.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/shell-test.mdx @@ -1,5 +1,7 @@ --- title: shell-test +description: | + Options for Pants' Shell test support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.19/reference/subsystems/shellcheck.mdx index 96c1acc67..0614d59e7 100644 --- a/versioned_docs/version-2.19/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.19/reference/subsystems/shfmt.mdx index 8fc494562..a47588ae1 100644 --- a/versioned_docs/version-2.19/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/shunit2.mdx b/versioned_docs/version-2.19/reference/subsystems/shunit2.mdx index de529d4b1..2fda1a5ee 100644 --- a/versioned_docs/version-2.19/reference/subsystems/shunit2.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/shunit2.mdx @@ -1,5 +1,7 @@ --- title: shunit2 +description: | + shUnit2 is a xUnit framework for Bourne based shell scripts (https://github.com/kward/shunit2) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/source.mdx b/versioned_docs/version-2.19/reference/subsystems/source.mdx index f1e3e4ac6..588b64338 100644 --- a/versioned_docs/version-2.19/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/spectral.mdx b/versioned_docs/version-2.19/reference/subsystems/spectral.mdx index 685a7e52e..011e995fb 100644 --- a/versioned_docs/version-2.19/reference/subsystems/spectral.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/spectral.mdx @@ -1,5 +1,7 @@ --- title: spectral +description: | + A flexible JSON/YAML linter for creating automated style guides (https://github.com/stoplightio/spectral). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/stats.mdx b/versioned_docs/version-2.19/reference/subsystems/stats.mdx index 9b6a026c2..75c3937b5 100644 --- a/versioned_docs/version-2.19/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.19/reference/subsystems/subprocess-environment.mdx index 8cda0d7cd..d7105e49d 100644 --- a/versioned_docs/version-2.19/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/system-binaries.mdx b/versioned_docs/version-2.19/reference/subsystems/system-binaries.mdx index ac867da36..acb59acf9 100644 --- a/versioned_docs/version-2.19/reference/subsystems/system-binaries.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/system-binaries.mdx @@ -1,5 +1,7 @@ --- title: system-binaries +description: | + System binaries related settings. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/terraform-fmt.mdx b/versioned_docs/version-2.19/reference/subsystems/terraform-fmt.mdx index 49bbf119b..e967d1f9c 100644 --- a/versioned_docs/version-2.19/reference/subsystems/terraform-fmt.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/terraform-fmt.mdx @@ -1,5 +1,7 @@ --- title: terraform-fmt +description: | + Terraform fmt options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/terraform-hcl2-parser.mdx b/versioned_docs/version-2.19/reference/subsystems/terraform-hcl2-parser.mdx index 0f8da3cab..afe0cda49 100644 --- a/versioned_docs/version-2.19/reference/subsystems/terraform-hcl2-parser.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/terraform-hcl2-parser.mdx @@ -1,5 +1,7 @@ --- title: terraform-hcl2-parser +description: | + Used to parse Terraform modules to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/terraform-validate.mdx b/versioned_docs/version-2.19/reference/subsystems/terraform-validate.mdx index edb178a87..6cb16de11 100644 --- a/versioned_docs/version-2.19/reference/subsystems/terraform-validate.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/terraform-validate.mdx @@ -1,5 +1,7 @@ --- title: terraform-validate +description: | + Terraform validate options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/thrift.mdx b/versioned_docs/version-2.19/reference/subsystems/thrift.mdx index 230854701..7a691f82d 100644 --- a/versioned_docs/version-2.19/reference/subsystems/thrift.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/thrift.mdx @@ -1,5 +1,7 @@ --- title: thrift +description: | + General Thrift IDL settings (https://thrift.apache.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/twine.mdx b/versioned_docs/version-2.19/reference/subsystems/twine.mdx index 53dcf12dc..8bc4c9a90 100644 --- a/versioned_docs/version-2.19/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPI and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/workunit-logger.mdx b/versioned_docs/version-2.19/reference/subsystems/workunit-logger.mdx index a33434a0e..09183ea36 100644 --- a/versioned_docs/version-2.19/reference/subsystems/workunit-logger.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/workunit-logger.mdx @@ -1,5 +1,7 @@ --- title: workunit-logger +description: | + Workunit Logger subsystem. Useful for debugging pants itself. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/yamllint.mdx b/versioned_docs/version-2.19/reference/subsystems/yamllint.mdx index 18d9b3abd..1b430af46 100644 --- a/versioned_docs/version-2.19/reference/subsystems/yamllint.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/yamllint.mdx @@ -1,5 +1,7 @@ --- title: yamllint +description: | + A linter for YAML files (https://yamllint.readthedocs.io) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/subsystems/yapf.mdx b/versioned_docs/version-2.19/reference/subsystems/yapf.mdx index b26cf40b6..bb2124129 100644 --- a/versioned_docs/version-2.19/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.19/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.19/reference/targets/adhoc_tool.mdx b/versioned_docs/version-2.19/reference/targets/adhoc_tool.mdx index 985e36caa..8b2d1dd9a 100644 --- a/versioned_docs/version-2.19/reference/targets/adhoc_tool.mdx +++ b/versioned_docs/version-2.19/reference/targets/adhoc_tool.mdx @@ -1,5 +1,7 @@ --- title: adhoc_tool +description: | + Execute any runnable target for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/archive.mdx b/versioned_docs/version-2.19/reference/targets/archive.mdx index b3f69629d..114cb1b42 100644 --- a/versioned_docs/version-2.19/reference/targets/archive.mdx +++ b/versioned_docs/version-2.19/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.19/reference/targets/deploy_jar.mdx index 6079abf19..6600c34ce 100644 --- a/versioned_docs/version-2.19/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.19/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/docker_environment.mdx b/versioned_docs/version-2.19/reference/targets/docker_environment.mdx index 8374a72e4..0c6629c71 100644 --- a/versioned_docs/version-2.19/reference/targets/docker_environment.mdx +++ b/versioned_docs/version-2.19/reference/targets/docker_environment.mdx @@ -1,5 +1,7 @@ --- title: docker_environment +description: | + Configuration of a Docker environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/docker_image.mdx b/versioned_docs/version-2.19/reference/targets/docker_image.mdx index ac26fe27c..0a41d81b3 100644 --- a/versioned_docs/version-2.19/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.19/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/experimental_test_shell_command.mdx b/versioned_docs/version-2.19/reference/targets/experimental_test_shell_command.mdx index 58eccc73a..7fbf84805 100644 --- a/versioned_docs/version-2.19/reference/targets/experimental_test_shell_command.mdx +++ b/versioned_docs/version-2.19/reference/targets/experimental_test_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_test_shell_command +description: | + Run a script as a test via the `test` goal, with all dependencies packaged/copied available in the chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_go_package_sources.mdx b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_go_package_sources.mdx index 0630639a4..b12d53c8d 100644 --- a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_go_package_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_go_package_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_go_package_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `GoPackageSourcesField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_java_sources.mdx b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_java_sources.mdx index ff3e04681..c3c6f8c4d 100644 --- a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_java_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_java_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_java_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `JavaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_kotlin_sources.mdx b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_kotlin_sources.mdx index bae3428a7..a17b55a26 100644 --- a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_kotlin_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_kotlin_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `KotlinSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_python_sources.mdx b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_python_sources.mdx index 5751ec09f..169ffa6c2 100644 --- a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_python_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_python_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_python_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `PythonSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_resources.mdx b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_resources.mdx index 7f60252a5..01b2659c6 100644 --- a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_resources.mdx +++ b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_resources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_resources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ResourceSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_scala_sources.mdx b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_scala_sources.mdx index 5548c481b..d08d758a2 100644 --- a/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_scala_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/experimental_wrap_as_scala_sources.mdx @@ -1,5 +1,7 @@ --- title: experimental_wrap_as_scala_sources +description: | + Allow files and sources produced by the targets specified by `inputs` to be consumed by rules that specifically expect a `ScalaSourceField`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/file.mdx b/versioned_docs/version-2.19/reference/targets/file.mdx index 520d6cc1e..824a75d11 100644 --- a/versioned_docs/version-2.19/reference/targets/file.mdx +++ b/versioned_docs/version-2.19/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/files.mdx b/versioned_docs/version-2.19/reference/targets/files.mdx index 7adba2e0d..cbabde4fd 100644 --- a/versioned_docs/version-2.19/reference/targets/files.mdx +++ b/versioned_docs/version-2.19/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/go_binary.mdx b/versioned_docs/version-2.19/reference/targets/go_binary.mdx index e1a85a7a6..3762d6c9d 100644 --- a/versioned_docs/version-2.19/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.19/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/go_mod.mdx b/versioned_docs/version-2.19/reference/targets/go_mod.mdx index a0cfd6173..eddaa16fd 100644 --- a/versioned_docs/version-2.19/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.19/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/go_package.mdx b/versioned_docs/version-2.19/reference/targets/go_package.mdx index ff9f04e71..2bb4598c6 100644 --- a/versioned_docs/version-2.19/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.19/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.19/reference/targets/go_third_party_package.mdx index df9c6ca79..18c21c41d 100644 --- a/versioned_docs/version-2.19/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.19/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/helm_artifact.mdx b/versioned_docs/version-2.19/reference/targets/helm_artifact.mdx index df2c66974..3278b9c18 100644 --- a/versioned_docs/version-2.19/reference/targets/helm_artifact.mdx +++ b/versioned_docs/version-2.19/reference/targets/helm_artifact.mdx @@ -1,5 +1,7 @@ --- title: helm_artifact +description: | + A third party Helm artifact. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/helm_chart.mdx b/versioned_docs/version-2.19/reference/targets/helm_chart.mdx index 8cc1c1c87..27f380869 100644 --- a/versioned_docs/version-2.19/reference/targets/helm_chart.mdx +++ b/versioned_docs/version-2.19/reference/targets/helm_chart.mdx @@ -1,5 +1,7 @@ --- title: helm_chart +description: | + A Helm chart. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/helm_deployment.mdx b/versioned_docs/version-2.19/reference/targets/helm_deployment.mdx index 0e1c2d730..2b2765b70 100644 --- a/versioned_docs/version-2.19/reference/targets/helm_deployment.mdx +++ b/versioned_docs/version-2.19/reference/targets/helm_deployment.mdx @@ -1,5 +1,7 @@ --- title: helm_deployment +description: | + A Helm chart deployment. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/helm_unittest_test.mdx b/versioned_docs/version-2.19/reference/targets/helm_unittest_test.mdx index 1db29c116..1bd133346 100644 --- a/versioned_docs/version-2.19/reference/targets/helm_unittest_test.mdx +++ b/versioned_docs/version-2.19/reference/targets/helm_unittest_test.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_test +description: | + A single helm-unittest suite file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/helm_unittest_tests.mdx b/versioned_docs/version-2.19/reference/targets/helm_unittest_tests.mdx index d159e932a..7166e1c4b 100644 --- a/versioned_docs/version-2.19/reference/targets/helm_unittest_tests.mdx +++ b/versioned_docs/version-2.19/reference/targets/helm_unittest_tests.mdx @@ -1,5 +1,7 @@ --- title: helm_unittest_tests +description: | + Generates a `helm_unittest_test` target per each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/java_source.mdx b/versioned_docs/version-2.19/reference/targets/java_source.mdx index 20b29ab6e..ade75df45 100644 --- a/versioned_docs/version-2.19/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.19/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/java_sources.mdx b/versioned_docs/version-2.19/reference/targets/java_sources.mdx index 5583288a8..c5984e6cb 100644 --- a/versioned_docs/version-2.19/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/junit_test.mdx b/versioned_docs/version-2.19/reference/targets/junit_test.mdx index 13a642920..f86dfaff6 100644 --- a/versioned_docs/version-2.19/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.19/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/junit_tests.mdx b/versioned_docs/version-2.19/reference/targets/junit_tests.mdx index d2e0af5b6..26d581931 100644 --- a/versioned_docs/version-2.19/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.19/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.19/reference/targets/jvm_artifact.mdx index 2f006d9e3..6d2a3bac9 100644 --- a/versioned_docs/version-2.19/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.19/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/jvm_war.mdx b/versioned_docs/version-2.19/reference/targets/jvm_war.mdx index 7a97c280e..3db9376ae 100644 --- a/versioned_docs/version-2.19/reference/targets/jvm_war.mdx +++ b/versioned_docs/version-2.19/reference/targets/jvm_war.mdx @@ -1,5 +1,7 @@ --- title: jvm_war +description: | + A JSR 154 "web application archive" (or "war") with first-party and third-party code bundled for deploys in Java Servlet containers. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/kotlin_junit_test.mdx b/versioned_docs/version-2.19/reference/targets/kotlin_junit_test.mdx index 01abd78c4..14676171b 100644 --- a/versioned_docs/version-2.19/reference/targets/kotlin_junit_test.mdx +++ b/versioned_docs/version-2.19/reference/targets/kotlin_junit_test.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_test +description: | + A single Kotlin test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/kotlin_junit_tests.mdx b/versioned_docs/version-2.19/reference/targets/kotlin_junit_tests.mdx index 7577c07d9..5811a245e 100644 --- a/versioned_docs/version-2.19/reference/targets/kotlin_junit_tests.mdx +++ b/versioned_docs/version-2.19/reference/targets/kotlin_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: kotlin_junit_tests +description: | + Generate a `kotlin_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/kotlin_source.mdx b/versioned_docs/version-2.19/reference/targets/kotlin_source.mdx index a942941ce..0e54a3d03 100644 --- a/versioned_docs/version-2.19/reference/targets/kotlin_source.mdx +++ b/versioned_docs/version-2.19/reference/targets/kotlin_source.mdx @@ -1,5 +1,7 @@ --- title: kotlin_source +description: | + A single Kotlin source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/kotlin_sources.mdx b/versioned_docs/version-2.19/reference/targets/kotlin_sources.mdx index d94e69f13..859b49278 100644 --- a/versioned_docs/version-2.19/reference/targets/kotlin_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/kotlin_sources.mdx @@ -1,5 +1,7 @@ --- title: kotlin_sources +description: | + Generate a `kotlin_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/kotlinc_plugin.mdx b/versioned_docs/version-2.19/reference/targets/kotlinc_plugin.mdx index 828754fa0..2614957de 100644 --- a/versioned_docs/version-2.19/reference/targets/kotlinc_plugin.mdx +++ b/versioned_docs/version-2.19/reference/targets/kotlinc_plugin.mdx @@ -1,5 +1,7 @@ --- title: kotlinc_plugin +description: | + A plugin for `kotlinc`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/local_environment.mdx b/versioned_docs/version-2.19/reference/targets/local_environment.mdx index 2a155a1a1..57285e437 100644 --- a/versioned_docs/version-2.19/reference/targets/local_environment.mdx +++ b/versioned_docs/version-2.19/reference/targets/local_environment.mdx @@ -1,5 +1,7 @@ --- title: local_environment +description: | + Configuration of a local execution environment for specific platforms. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/openapi_document.mdx b/versioned_docs/version-2.19/reference/targets/openapi_document.mdx index 7efe68f16..e8e93df77 100644 --- a/versioned_docs/version-2.19/reference/targets/openapi_document.mdx +++ b/versioned_docs/version-2.19/reference/targets/openapi_document.mdx @@ -1,5 +1,7 @@ --- title: openapi_document +description: | + A single OpenAPI document file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/openapi_documents.mdx b/versioned_docs/version-2.19/reference/targets/openapi_documents.mdx index 6e657e47d..f36e3a1ae 100644 --- a/versioned_docs/version-2.19/reference/targets/openapi_documents.mdx +++ b/versioned_docs/version-2.19/reference/targets/openapi_documents.mdx @@ -1,5 +1,7 @@ --- title: openapi_documents +description: | + Generate an `openapi_document` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/openapi_source.mdx b/versioned_docs/version-2.19/reference/targets/openapi_source.mdx index df6f62889..130de4cf4 100644 --- a/versioned_docs/version-2.19/reference/targets/openapi_source.mdx +++ b/versioned_docs/version-2.19/reference/targets/openapi_source.mdx @@ -1,5 +1,7 @@ --- title: openapi_source +description: | + A single OpenAPI source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/openapi_sources.mdx b/versioned_docs/version-2.19/reference/targets/openapi_sources.mdx index 0c79e573f..2fc3d0d1c 100644 --- a/versioned_docs/version-2.19/reference/targets/openapi_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/openapi_sources.mdx @@ -1,5 +1,7 @@ --- title: openapi_sources +description: | + Generate an `openapi_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.19/reference/targets/pants_requirements.mdx index 6cfec2b84..cb518bff2 100644 --- a/versioned_docs/version-2.19/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.19/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/pex_binaries.mdx b/versioned_docs/version-2.19/reference/targets/pex_binaries.mdx index 7faf9c0ef..e9963d33b 100644 --- a/versioned_docs/version-2.19/reference/targets/pex_binaries.mdx +++ b/versioned_docs/version-2.19/reference/targets/pex_binaries.mdx @@ -1,5 +1,7 @@ --- title: pex_binaries +description: | + Generate a `pex_binary` target for each entry_point in the `entry_points` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/pex_binary.mdx b/versioned_docs/version-2.19/reference/targets/pex_binary.mdx index 7459139db..4518bb4a7 100644 --- a/versioned_docs/version-2.19/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.19/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/pipenv_requirements.mdx b/versioned_docs/version-2.19/reference/targets/pipenv_requirements.mdx index f67f613c7..8232eece0 100644 --- a/versioned_docs/version-2.19/reference/targets/pipenv_requirements.mdx +++ b/versioned_docs/version-2.19/reference/targets/pipenv_requirements.mdx @@ -1,5 +1,7 @@ --- title: pipenv_requirements +description: | + Generate a `python_requirement` for each entry in `Pipenv.lock`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/poetry_requirements.mdx b/versioned_docs/version-2.19/reference/targets/poetry_requirements.mdx index 6edf88e02..b33cbf23b 100644 --- a/versioned_docs/version-2.19/reference/targets/poetry_requirements.mdx +++ b/versioned_docs/version-2.19/reference/targets/poetry_requirements.mdx @@ -1,5 +1,7 @@ --- title: poetry_requirements +description: | + Generate a `python_requirement` for each entry in a Poetry `pyproject.toml`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.19/reference/targets/protobuf_source.mdx index 1ba0a4298..48d911fe0 100644 --- a/versioned_docs/version-2.19/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.19/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.19/reference/targets/protobuf_sources.mdx index 8054bad9b..83683d9c7 100644 --- a/versioned_docs/version-2.19/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/pyoxidizer_binary.mdx b/versioned_docs/version-2.19/reference/targets/pyoxidizer_binary.mdx index fe7f2ae9f..876a31405 100644 --- a/versioned_docs/version-2.19/reference/targets/pyoxidizer_binary.mdx +++ b/versioned_docs/version-2.19/reference/targets/pyoxidizer_binary.mdx @@ -1,5 +1,7 @@ --- title: pyoxidizer_binary +description: | + A single-file Python executable with a Python interpreter embedded, built via PyOxidizer. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_aws_lambda_function.mdx b/versioned_docs/version-2.19/reference/targets/python_aws_lambda_function.mdx index 2b7002fc4..bfc02ab45 100644 --- a/versioned_docs/version-2.19/reference/targets/python_aws_lambda_function.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_aws_lambda_function.mdx @@ -1,5 +1,7 @@ --- title: python_aws_lambda_function +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_aws_lambda_layer.mdx b/versioned_docs/version-2.19/reference/targets/python_aws_lambda_layer.mdx index 11019185d..30071ab63 100644 --- a/versioned_docs/version-2.19/reference/targets/python_aws_lambda_layer.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_aws_lambda_layer.mdx @@ -1,5 +1,7 @@ --- title: python_aws_lambda_layer +description: | + A Python layer suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_distribution.mdx b/versioned_docs/version-2.19/reference/targets/python_distribution.mdx index b229af861..4b57c232c 100644 --- a/versioned_docs/version-2.19/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.19/reference/targets/python_google_cloud_function.mdx index d9ac50ca4..4bc7b4eea 100644 --- a/versioned_docs/version-2.19/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_requirement.mdx b/versioned_docs/version-2.19/reference/targets/python_requirement.mdx index 206c393b7..f883dee6f 100644 --- a/versioned_docs/version-2.19/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_requirements.mdx b/versioned_docs/version-2.19/reference/targets/python_requirements.mdx index b4078a301..a891310f2 100644 --- a/versioned_docs/version-2.19/reference/targets/python_requirements.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_requirements.mdx @@ -1,5 +1,7 @@ --- title: python_requirements +description: | + Generate a `python_requirement` for each entry in a requirements.txt-style or PEP 621 compliant `pyproject.toml` file. The choice of parser for the `source` field is determined by the file name. If the `source` field ends with `pyproject.toml`, then the file is assumed to be a PEP 621 compliant file. Any other file name uses the requirements.txt-style parser. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_source.mdx b/versioned_docs/version-2.19/reference/targets/python_source.mdx index a82d50c83..ddd9b37e4 100644 --- a/versioned_docs/version-2.19/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_sources.mdx b/versioned_docs/version-2.19/reference/targets/python_sources.mdx index 120e8f6b0..cd2bcc0bd 100644 --- a/versioned_docs/version-2.19/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_test.mdx b/versioned_docs/version-2.19/reference/targets/python_test.mdx index c990b871d..4ea593757 100644 --- a/versioned_docs/version-2.19/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.19/reference/targets/python_test_utils.mdx index 9aaf21127..d26508920 100644 --- a/versioned_docs/version-2.19/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/python_tests.mdx b/versioned_docs/version-2.19/reference/targets/python_tests.mdx index a4c705cad..81c50e94c 100644 --- a/versioned_docs/version-2.19/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.19/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/relocated_files.mdx b/versioned_docs/version-2.19/reference/targets/relocated_files.mdx index 346339e69..9efc94ea5 100644 --- a/versioned_docs/version-2.19/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.19/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/remote_environment.mdx b/versioned_docs/version-2.19/reference/targets/remote_environment.mdx index d7538a03a..6abe312f6 100644 --- a/versioned_docs/version-2.19/reference/targets/remote_environment.mdx +++ b/versioned_docs/version-2.19/reference/targets/remote_environment.mdx @@ -1,5 +1,7 @@ --- title: remote_environment +description: | + Configuration of a remote execution environment used for building your code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/resource.mdx b/versioned_docs/version-2.19/reference/targets/resource.mdx index 36a9496d3..1dee35093 100644 --- a/versioned_docs/version-2.19/reference/targets/resource.mdx +++ b/versioned_docs/version-2.19/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/resources.mdx b/versioned_docs/version-2.19/reference/targets/resources.mdx index e8959bfd3..4a06364eb 100644 --- a/versioned_docs/version-2.19/reference/targets/resources.mdx +++ b/versioned_docs/version-2.19/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/run_shell_command.mdx b/versioned_docs/version-2.19/reference/targets/run_shell_command.mdx index bf8dfe79c..e705072a2 100644 --- a/versioned_docs/version-2.19/reference/targets/run_shell_command.mdx +++ b/versioned_docs/version-2.19/reference/targets/run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/scala_artifact.mdx b/versioned_docs/version-2.19/reference/targets/scala_artifact.mdx index 5cdfb927d..db20aa66a 100644 --- a/versioned_docs/version-2.19/reference/targets/scala_artifact.mdx +++ b/versioned_docs/version-2.19/reference/targets/scala_artifact.mdx @@ -1,5 +1,7 @@ --- title: scala_artifact +description: | + A third-party Scala artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.19/reference/targets/scala_junit_test.mdx index be3e33c5f..6df7f3e44 100644 --- a/versioned_docs/version-2.19/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.19/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.19/reference/targets/scala_junit_tests.mdx index aae7de49f..30f1aa39a 100644 --- a/versioned_docs/version-2.19/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.19/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/scala_source.mdx b/versioned_docs/version-2.19/reference/targets/scala_source.mdx index 58500c2b7..d067d3529 100644 --- a/versioned_docs/version-2.19/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.19/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/scala_sources.mdx b/versioned_docs/version-2.19/reference/targets/scala_sources.mdx index 679cb9a0d..f1639768e 100644 --- a/versioned_docs/version-2.19/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.19/reference/targets/scalac_plugin.mdx index 5debfdf3a..d6596589c 100644 --- a/versioned_docs/version-2.19/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.19/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.19/reference/targets/scalatest_test.mdx index 29df9882e..3dbd03596 100644 --- a/versioned_docs/version-2.19/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.19/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.19/reference/targets/scalatest_tests.mdx index b6431cc32..0906f9498 100644 --- a/versioned_docs/version-2.19/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.19/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching `('*Spec.scala', '*Suite.scala')`). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/shell_command.mdx b/versioned_docs/version-2.19/reference/targets/shell_command.mdx index 1e096b900..93850944e 100644 --- a/versioned_docs/version-2.19/reference/targets/shell_command.mdx +++ b/versioned_docs/version-2.19/reference/targets/shell_command.mdx @@ -1,5 +1,7 @@ --- title: shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/shell_source.mdx b/versioned_docs/version-2.19/reference/targets/shell_source.mdx index b1e575575..c60677e64 100644 --- a/versioned_docs/version-2.19/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.19/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/shell_sources.mdx b/versioned_docs/version-2.19/reference/targets/shell_sources.mdx index 1ea3a68c3..8b17cbcd0 100644 --- a/versioned_docs/version-2.19/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.19/reference/targets/shunit2_test.mdx index 6f8d18103..7bdd1f2e3 100644 --- a/versioned_docs/version-2.19/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.19/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.19/reference/targets/shunit2_tests.mdx index 2bd9dd440..8f68f9834 100644 --- a/versioned_docs/version-2.19/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.19/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/system_binary.mdx b/versioned_docs/version-2.19/reference/targets/system_binary.mdx index d7bd775a0..017c61020 100644 --- a/versioned_docs/version-2.19/reference/targets/system_binary.mdx +++ b/versioned_docs/version-2.19/reference/targets/system_binary.mdx @@ -1,5 +1,7 @@ --- title: system_binary +description: | + A system binary that can be run with `pants run` or consumed by `adhoc_tool`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/target.mdx b/versioned_docs/version-2.19/reference/targets/target.mdx index 160c4aee9..7db07a078 100644 --- a/versioned_docs/version-2.19/reference/targets/target.mdx +++ b/versioned_docs/version-2.19/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/terraform_deployment.mdx b/versioned_docs/version-2.19/reference/targets/terraform_deployment.mdx index b40be8aab..a4f9a09f1 100644 --- a/versioned_docs/version-2.19/reference/targets/terraform_deployment.mdx +++ b/versioned_docs/version-2.19/reference/targets/terraform_deployment.mdx @@ -1,5 +1,7 @@ --- title: terraform_deployment +description: | + A deployment of Terraform --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/terraform_module.mdx b/versioned_docs/version-2.19/reference/targets/terraform_module.mdx index 5fa726199..613e3ffa8 100644 --- a/versioned_docs/version-2.19/reference/targets/terraform_module.mdx +++ b/versioned_docs/version-2.19/reference/targets/terraform_module.mdx @@ -1,5 +1,7 @@ --- title: terraform_module +description: | + A single Terraform module corresponding to a directory. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/thrift_source.mdx b/versioned_docs/version-2.19/reference/targets/thrift_source.mdx index 56b3e4cba..ff0ec8e79 100644 --- a/versioned_docs/version-2.19/reference/targets/thrift_source.mdx +++ b/versioned_docs/version-2.19/reference/targets/thrift_source.mdx @@ -1,5 +1,7 @@ --- title: thrift_source +description: | + A single Thrift file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/thrift_sources.mdx b/versioned_docs/version-2.19/reference/targets/thrift_sources.mdx index b8b76e4bc..e6dcb7780 100644 --- a/versioned_docs/version-2.19/reference/targets/thrift_sources.mdx +++ b/versioned_docs/version-2.19/reference/targets/thrift_sources.mdx @@ -1,5 +1,7 @@ --- title: thrift_sources +description: | + Generate a `thrift_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.19/reference/targets/vcs_version.mdx b/versioned_docs/version-2.19/reference/targets/vcs_version.mdx index 9b58dc7e0..c2c8c60b8 100644 --- a/versioned_docs/version-2.19/reference/targets/vcs_version.mdx +++ b/versioned_docs/version-2.19/reference/targets/vcs_version.mdx @@ -1,5 +1,7 @@ --- title: vcs_version +description: | + Generates a version string from VCS state. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/global-options.mdx b/versioned_docs/version-2.2/reference/global-options.mdx index 1d7b690e5..845475d16 100644 --- a/versioned_docs/version-2.2/reference/global-options.mdx +++ b/versioned_docs/version-2.2/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/count-loc.mdx b/versioned_docs/version-2.2/reference/goals/count-loc.mdx index 5db22e25e..cdc355e08 100644 --- a/versioned_docs/version-2.2/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.2/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/dependees.mdx b/versioned_docs/version-2.2/reference/goals/dependees.mdx index a0f25c578..d8e604698 100644 --- a/versioned_docs/version-2.2/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.2/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/dependencies.mdx b/versioned_docs/version-2.2/reference/goals/dependencies.mdx index df1a18e07..35ab9042e 100644 --- a/versioned_docs/version-2.2/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.2/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/export-codegen.mdx b/versioned_docs/version-2.2/reference/goals/export-codegen.mdx index ae3123ac7..b8ee7c698 100644 --- a/versioned_docs/version-2.2/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.2/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/filedeps.mdx b/versioned_docs/version-2.2/reference/goals/filedeps.mdx index 515489a18..bf3b5b2ae 100644 --- a/versioned_docs/version-2.2/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.2/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/filter.mdx b/versioned_docs/version-2.2/reference/goals/filter.mdx index 58c7d0420..921460b84 100644 --- a/versioned_docs/version-2.2/reference/goals/filter.mdx +++ b/versioned_docs/version-2.2/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/fmt.mdx b/versioned_docs/version-2.2/reference/goals/fmt.mdx index 06e69a6fd..1797c83be 100644 --- a/versioned_docs/version-2.2/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.2/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/lint.mdx b/versioned_docs/version-2.2/reference/goals/lint.mdx index 0e46f0ffb..f6d590c36 100644 --- a/versioned_docs/version-2.2/reference/goals/lint.mdx +++ b/versioned_docs/version-2.2/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/list.mdx b/versioned_docs/version-2.2/reference/goals/list.mdx index a0728060b..255a7d00c 100644 --- a/versioned_docs/version-2.2/reference/goals/list.mdx +++ b/versioned_docs/version-2.2/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/package.mdx b/versioned_docs/version-2.2/reference/goals/package.mdx index 5b6bb28a4..cf288c6b3 100644 --- a/versioned_docs/version-2.2/reference/goals/package.mdx +++ b/versioned_docs/version-2.2/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/py-constraints.mdx b/versioned_docs/version-2.2/reference/goals/py-constraints.mdx index 5a389d7ec..6c823e306 100644 --- a/versioned_docs/version-2.2/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.2/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/repl.mdx b/versioned_docs/version-2.2/reference/goals/repl.mdx index 2b514c49c..b653d8553 100644 --- a/versioned_docs/version-2.2/reference/goals/repl.mdx +++ b/versioned_docs/version-2.2/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/roots.mdx b/versioned_docs/version-2.2/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.2/reference/goals/roots.mdx +++ b/versioned_docs/version-2.2/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/run.mdx b/versioned_docs/version-2.2/reference/goals/run.mdx index 3130559f8..6f268e566 100644 --- a/versioned_docs/version-2.2/reference/goals/run.mdx +++ b/versioned_docs/version-2.2/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/test.mdx b/versioned_docs/version-2.2/reference/goals/test.mdx index 0ce95ea0d..725dd6af5 100644 --- a/versioned_docs/version-2.2/reference/goals/test.mdx +++ b/versioned_docs/version-2.2/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/typecheck.mdx b/versioned_docs/version-2.2/reference/goals/typecheck.mdx index 660de7077..6dad17a1c 100644 --- a/versioned_docs/version-2.2/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.2/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checkers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/goals/validate.mdx b/versioned_docs/version-2.2/reference/goals/validate.mdx index da7304f15..f2c915119 100644 --- a/versioned_docs/version-2.2/reference/goals/validate.mdx +++ b/versioned_docs/version-2.2/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/bandit.mdx b/versioned_docs/version-2.2/reference/subsystems/bandit.mdx index a05214f2c..6e5121954 100644 --- a/versioned_docs/version-2.2/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/black.mdx b/versioned_docs/version-2.2/reference/subsystems/black.mdx index 420ffe609..570cfae50 100644 --- a/versioned_docs/version-2.2/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/changed.mdx b/versioned_docs/version-2.2/reference/subsystems/changed.mdx index 4a3bdfbd7..bb8740fb3 100644 --- a/versioned_docs/version-2.2/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.2/reference/subsystems/coverage-py.mdx index 0d47ffe24..0db6544b9 100644 --- a/versioned_docs/version-2.2/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.2/reference/subsystems/docformatter.mdx index 9cf767cd3..e5f64d5ae 100644 --- a/versioned_docs/version-2.2/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.2/reference/subsystems/download-pex-bin.mdx index 783e4cd1d..664417126 100644 --- a/versioned_docs/version-2.2/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/flake8.mdx b/versioned_docs/version-2.2/reference/subsystems/flake8.mdx index 2a8d9501f..6ac54f483 100644 --- a/versioned_docs/version-2.2/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/grpc_python_plugin.mdx b/versioned_docs/version-2.2/reference/subsystems/grpc_python_plugin.mdx index b881f7151..9cf467f43 100644 --- a/versioned_docs/version-2.2/reference/subsystems/grpc_python_plugin.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/grpc_python_plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc_python_plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/ipython.mdx b/versioned_docs/version-2.2/reference/subsystems/ipython.mdx index 46a16091a..b59f75edc 100644 --- a/versioned_docs/version-2.2/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/isort.mdx b/versioned_docs/version-2.2/reference/subsystems/isort.mdx index 71436c246..567028b42 100644 --- a/versioned_docs/version-2.2/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://timothycrosley.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.2/reference/subsystems/lambdex.mdx index 68ae3ac8f..dd724dfd1 100644 --- a/versioned_docs/version-2.2/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into AWS Lambdas (https://github.com/wickman/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/mypy.mdx b/versioned_docs/version-2.2/reference/subsystems/mypy.mdx index 3bba11596..9e20c876a 100644 --- a/versioned_docs/version-2.2/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.2/reference/subsystems/pex-binary-defaults.mdx index f439d5d21..f47a724a4 100644 --- a/versioned_docs/version-2.2/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/pex.mdx b/versioned_docs/version-2.2/reference/subsystems/pex.mdx index 6d6d56704..1f86d9ecc 100644 --- a/versioned_docs/version-2.2/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/protoc.mdx b/versioned_docs/version-2.2/reference/subsystems/protoc.mdx index 485fb0383..1a3993a44 100644 --- a/versioned_docs/version-2.2/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/pylint.mdx b/versioned_docs/version-2.2/reference/subsystems/pylint.mdx index 5031f2d16..c5de9cf98 100644 --- a/versioned_docs/version-2.2/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/pytest.mdx b/versioned_docs/version-2.2/reference/subsystems/pytest.mdx index 92c379478..b75ced5ec 100644 --- a/versioned_docs/version-2.2/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.2/reference/subsystems/python-infer.mdx index bcc5d7d18..77bd226d5 100644 --- a/versioned_docs/version-2.2/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.2/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.2/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.2/reference/subsystems/python-protobuf.mdx index 596ef6fd6..a10d1584b 100644 --- a/versioned_docs/version-2.2/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.2/reference/subsystems/python-repos.mdx index 9251d2c4e..bee1ff73f 100644 --- a/versioned_docs/version-2.2/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.2/reference/subsystems/python-setup.mdx index 3b4ac8d1b..5dbc6fb45 100644 --- a/versioned_docs/version-2.2/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + Options for Pants's Python support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/run-tracker.mdx b/versioned_docs/version-2.2/reference/subsystems/run-tracker.mdx index 6825c4b01..41afd31e1 100644 --- a/versioned_docs/version-2.2/reference/subsystems/run-tracker.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/run-tracker.mdx @@ -1,5 +1,7 @@ --- title: run-tracker +description: | + Tracks and times the execution of a pants run. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/scc.mdx b/versioned_docs/version-2.2/reference/subsystems/scc.mdx index 9ff9d0a4d..684ff81a7 100644 --- a/versioned_docs/version-2.2/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.2/reference/subsystems/setup-py-generation.mdx index 5b4cd4e97..8dcae9a51 100644 --- a/versioned_docs/version-2.2/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.2/reference/subsystems/setuptools.mdx index 901fb3bd0..971fe713b 100644 --- a/versioned_docs/version-2.2/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + The Python setuptools library (https://github.com/pypa/setuptools). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/source.mdx b/versioned_docs/version-2.2/reference/subsystems/source.mdx index 7b6b319f3..0809918b4 100644 --- a/versioned_docs/version-2.2/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.2/reference/subsystems/sourcefile-validation.mdx index 6e58015a8..8c61abda2 100644 --- a/versioned_docs/version-2.2/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.2/reference/subsystems/subprocess-environment.mdx index ec8321783..ff0b92195 100644 --- a/versioned_docs/version-2.2/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.2/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.2/reference/targets/archive.mdx b/versioned_docs/version-2.2/reference/targets/archive.mdx index 0a0ace91c..cf43f2eaf 100644 --- a/versioned_docs/version-2.2/reference/targets/archive.mdx +++ b/versioned_docs/version-2.2/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/files.mdx b/versioned_docs/version-2.2/reference/targets/files.mdx index 3075fe934..306a88325 100644 --- a/versioned_docs/version-2.2/reference/targets/files.mdx +++ b/versioned_docs/version-2.2/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Loose files that live outside code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/pex_binary.mdx b/versioned_docs/version-2.2/reference/targets/pex_binary.mdx index 77c64b5e8..5d9a80570 100644 --- a/versioned_docs/version-2.2/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.2/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/protobuf_library.mdx b/versioned_docs/version-2.2/reference/targets/protobuf_library.mdx index 7e4f1f28f..9e0ccf807 100644 --- a/versioned_docs/version-2.2/reference/targets/protobuf_library.mdx +++ b/versioned_docs/version-2.2/reference/targets/protobuf_library.mdx @@ -1,5 +1,7 @@ --- title: protobuf_library +description: | + Protobuf files used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.2/reference/targets/python_awslambda.mdx index aa7f7f356..7d0b25856 100644 --- a/versioned_docs/version-2.2/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.2/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/python_distribution.mdx b/versioned_docs/version-2.2/reference/targets/python_distribution.mdx index 5e8d80af5..58032a7ac 100644 --- a/versioned_docs/version-2.2/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.2/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/python_library.mdx b/versioned_docs/version-2.2/reference/targets/python_library.mdx index cea8035f4..1dab894a2 100644 --- a/versioned_docs/version-2.2/reference/targets/python_library.mdx +++ b/versioned_docs/version-2.2/reference/targets/python_library.mdx @@ -1,5 +1,7 @@ --- title: python_library +description: | + Python source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/python_requirement_library.mdx b/versioned_docs/version-2.2/reference/targets/python_requirement_library.mdx index 74cf91582..b7f07ca8e 100644 --- a/versioned_docs/version-2.2/reference/targets/python_requirement_library.mdx +++ b/versioned_docs/version-2.2/reference/targets/python_requirement_library.mdx @@ -1,5 +1,7 @@ --- title: python_requirement_library +description: | + Python requirements installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/python_tests.mdx b/versioned_docs/version-2.2/reference/targets/python_tests.mdx index 8af7b4f4b..156906296 100644 --- a/versioned_docs/version-2.2/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.2/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Python tests, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/relocated_files.mdx b/versioned_docs/version-2.2/reference/targets/relocated_files.mdx index b16c8a40c..6b04eb1a7 100644 --- a/versioned_docs/version-2.2/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.2/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/resources.mdx b/versioned_docs/version-2.2/reference/targets/resources.mdx index d869050c6..edc774762 100644 --- a/versioned_docs/version-2.2/reference/targets/resources.mdx +++ b/versioned_docs/version-2.2/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Data embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.2/reference/targets/target.mdx b/versioned_docs/version-2.2/reference/targets/target.mdx index 2004048bc..e43185222 100644 --- a/versioned_docs/version-2.2/reference/targets/target.mdx +++ b/versioned_docs/version-2.2/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/global-options.mdx b/versioned_docs/version-2.3/reference/global-options.mdx index cd10709e5..4a32aafa1 100644 --- a/versioned_docs/version-2.3/reference/global-options.mdx +++ b/versioned_docs/version-2.3/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/count-loc.mdx b/versioned_docs/version-2.3/reference/goals/count-loc.mdx index 5db22e25e..cdc355e08 100644 --- a/versioned_docs/version-2.3/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.3/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/dependees.mdx b/versioned_docs/version-2.3/reference/goals/dependees.mdx index a0f25c578..d8e604698 100644 --- a/versioned_docs/version-2.3/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.3/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/dependencies.mdx b/versioned_docs/version-2.3/reference/goals/dependencies.mdx index df1a18e07..35ab9042e 100644 --- a/versioned_docs/version-2.3/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.3/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/export-codegen.mdx b/versioned_docs/version-2.3/reference/goals/export-codegen.mdx index ae3123ac7..b8ee7c698 100644 --- a/versioned_docs/version-2.3/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.3/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/filedeps.mdx b/versioned_docs/version-2.3/reference/goals/filedeps.mdx index 515489a18..bf3b5b2ae 100644 --- a/versioned_docs/version-2.3/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.3/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/filter.mdx b/versioned_docs/version-2.3/reference/goals/filter.mdx index 58c7d0420..921460b84 100644 --- a/versioned_docs/version-2.3/reference/goals/filter.mdx +++ b/versioned_docs/version-2.3/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/fmt.mdx b/versioned_docs/version-2.3/reference/goals/fmt.mdx index 06e69a6fd..1797c83be 100644 --- a/versioned_docs/version-2.3/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.3/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/lint.mdx b/versioned_docs/version-2.3/reference/goals/lint.mdx index 0e46f0ffb..f6d590c36 100644 --- a/versioned_docs/version-2.3/reference/goals/lint.mdx +++ b/versioned_docs/version-2.3/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/list.mdx b/versioned_docs/version-2.3/reference/goals/list.mdx index a0728060b..255a7d00c 100644 --- a/versioned_docs/version-2.3/reference/goals/list.mdx +++ b/versioned_docs/version-2.3/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/package.mdx b/versioned_docs/version-2.3/reference/goals/package.mdx index 5b6bb28a4..cf288c6b3 100644 --- a/versioned_docs/version-2.3/reference/goals/package.mdx +++ b/versioned_docs/version-2.3/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/py-constraints.mdx b/versioned_docs/version-2.3/reference/goals/py-constraints.mdx index 5a389d7ec..6c823e306 100644 --- a/versioned_docs/version-2.3/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.3/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/repl.mdx b/versioned_docs/version-2.3/reference/goals/repl.mdx index 2b514c49c..b653d8553 100644 --- a/versioned_docs/version-2.3/reference/goals/repl.mdx +++ b/versioned_docs/version-2.3/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/roots.mdx b/versioned_docs/version-2.3/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.3/reference/goals/roots.mdx +++ b/versioned_docs/version-2.3/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/run.mdx b/versioned_docs/version-2.3/reference/goals/run.mdx index 3130559f8..6f268e566 100644 --- a/versioned_docs/version-2.3/reference/goals/run.mdx +++ b/versioned_docs/version-2.3/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/tailor.mdx b/versioned_docs/version-2.3/reference/goals/tailor.mdx index 565af390b..b92f4933f 100644 --- a/versioned_docs/version-2.3/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.3/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/test.mdx b/versioned_docs/version-2.3/reference/goals/test.mdx index 0ce95ea0d..725dd6af5 100644 --- a/versioned_docs/version-2.3/reference/goals/test.mdx +++ b/versioned_docs/version-2.3/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/typecheck.mdx b/versioned_docs/version-2.3/reference/goals/typecheck.mdx index 660de7077..6dad17a1c 100644 --- a/versioned_docs/version-2.3/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.3/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checkers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/goals/validate.mdx b/versioned_docs/version-2.3/reference/goals/validate.mdx index da7304f15..f2c915119 100644 --- a/versioned_docs/version-2.3/reference/goals/validate.mdx +++ b/versioned_docs/version-2.3/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/bandit.mdx b/versioned_docs/version-2.3/reference/subsystems/bandit.mdx index a05214f2c..6e5121954 100644 --- a/versioned_docs/version-2.3/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/black.mdx b/versioned_docs/version-2.3/reference/subsystems/black.mdx index 420ffe609..570cfae50 100644 --- a/versioned_docs/version-2.3/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/changed.mdx b/versioned_docs/version-2.3/reference/subsystems/changed.mdx index 86f144cec..fc3018227 100644 --- a/versioned_docs/version-2.3/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.3/reference/subsystems/coverage-py.mdx index 0d47ffe24..0db6544b9 100644 --- a/versioned_docs/version-2.3/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.3/reference/subsystems/docformatter.mdx index cee629ded..9f1656034 100644 --- a/versioned_docs/version-2.3/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.3/reference/subsystems/download-pex-bin.mdx index 4b43fd513..b220cb5d6 100644 --- a/versioned_docs/version-2.3/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/flake8.mdx b/versioned_docs/version-2.3/reference/subsystems/flake8.mdx index 2a8d9501f..6ac54f483 100644 --- a/versioned_docs/version-2.3/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/grpc_python_plugin.mdx b/versioned_docs/version-2.3/reference/subsystems/grpc_python_plugin.mdx index e7a18fd5b..c4b9512f4 100644 --- a/versioned_docs/version-2.3/reference/subsystems/grpc_python_plugin.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/grpc_python_plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc_python_plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/ipython.mdx b/versioned_docs/version-2.3/reference/subsystems/ipython.mdx index 46a16091a..b59f75edc 100644 --- a/versioned_docs/version-2.3/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/isort.mdx b/versioned_docs/version-2.3/reference/subsystems/isort.mdx index 71436c246..567028b42 100644 --- a/versioned_docs/version-2.3/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://timothycrosley.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.3/reference/subsystems/lambdex.mdx index 68ae3ac8f..dd724dfd1 100644 --- a/versioned_docs/version-2.3/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into AWS Lambdas (https://github.com/wickman/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/mypy.mdx b/versioned_docs/version-2.3/reference/subsystems/mypy.mdx index b81a08ee2..06ee798f3 100644 --- a/versioned_docs/version-2.3/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.3/reference/subsystems/pex-binary-defaults.mdx index f439d5d21..f47a724a4 100644 --- a/versioned_docs/version-2.3/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/pex.mdx b/versioned_docs/version-2.3/reference/subsystems/pex.mdx index 6d6d56704..1f86d9ecc 100644 --- a/versioned_docs/version-2.3/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/protoc.mdx b/versioned_docs/version-2.3/reference/subsystems/protoc.mdx index 6d9fe83d0..1acc0fed1 100644 --- a/versioned_docs/version-2.3/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/pylint.mdx b/versioned_docs/version-2.3/reference/subsystems/pylint.mdx index 321a1d729..4eac80691 100644 --- a/versioned_docs/version-2.3/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/pytest.mdx b/versioned_docs/version-2.3/reference/subsystems/pytest.mdx index ddc1d2625..193773ad9 100644 --- a/versioned_docs/version-2.3/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.3/reference/subsystems/python-infer.mdx index bcc5d7d18..77bd226d5 100644 --- a/versioned_docs/version-2.3/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.3/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.3/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.3/reference/subsystems/python-protobuf.mdx index 13cefe3f6..dac12d5d0 100644 --- a/versioned_docs/version-2.3/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.3/reference/subsystems/python-repos.mdx index 9251d2c4e..bee1ff73f 100644 --- a/versioned_docs/version-2.3/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.3/reference/subsystems/python-setup.mdx index fcead7857..c7a161b2b 100644 --- a/versioned_docs/version-2.3/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + Options for Pants's Python support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/scc.mdx b/versioned_docs/version-2.3/reference/subsystems/scc.mdx index 469084292..4a9a82b85 100644 --- a/versioned_docs/version-2.3/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.3/reference/subsystems/setup-py-generation.mdx index 5b4cd4e97..8dcae9a51 100644 --- a/versioned_docs/version-2.3/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.3/reference/subsystems/setuptools.mdx index 97f1d820e..7be6148a7 100644 --- a/versioned_docs/version-2.3/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + The Python setuptools library (https://github.com/pypa/setuptools). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/source.mdx b/versioned_docs/version-2.3/reference/subsystems/source.mdx index 74d272dd2..d5bc50d68 100644 --- a/versioned_docs/version-2.3/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.3/reference/subsystems/sourcefile-validation.mdx index 6e58015a8..8c61abda2 100644 --- a/versioned_docs/version-2.3/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.3/reference/subsystems/subprocess-environment.mdx index 10f6580b4..17ba0a093 100644 --- a/versioned_docs/version-2.3/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.3/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.3/reference/targets/archive.mdx b/versioned_docs/version-2.3/reference/targets/archive.mdx index 0050dd99d..648f311b2 100644 --- a/versioned_docs/version-2.3/reference/targets/archive.mdx +++ b/versioned_docs/version-2.3/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/files.mdx b/versioned_docs/version-2.3/reference/targets/files.mdx index 537f85d43..18cf314e7 100644 --- a/versioned_docs/version-2.3/reference/targets/files.mdx +++ b/versioned_docs/version-2.3/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Loose files that live outside code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/pex_binary.mdx b/versioned_docs/version-2.3/reference/targets/pex_binary.mdx index 2de3c4344..6f27db938 100644 --- a/versioned_docs/version-2.3/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.3/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/protobuf_library.mdx b/versioned_docs/version-2.3/reference/targets/protobuf_library.mdx index 84f10fd8b..14d9ce34b 100644 --- a/versioned_docs/version-2.3/reference/targets/protobuf_library.mdx +++ b/versioned_docs/version-2.3/reference/targets/protobuf_library.mdx @@ -1,5 +1,7 @@ --- title: protobuf_library +description: | + Protobuf files used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.3/reference/targets/python_awslambda.mdx index 30d3c89cf..aa367dcc4 100644 --- a/versioned_docs/version-2.3/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.3/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/python_distribution.mdx b/versioned_docs/version-2.3/reference/targets/python_distribution.mdx index 999e39ee4..c6b44468c 100644 --- a/versioned_docs/version-2.3/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.3/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/python_library.mdx b/versioned_docs/version-2.3/reference/targets/python_library.mdx index 7487c4217..f63220351 100644 --- a/versioned_docs/version-2.3/reference/targets/python_library.mdx +++ b/versioned_docs/version-2.3/reference/targets/python_library.mdx @@ -1,5 +1,7 @@ --- title: python_library +description: | + Python source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/python_requirement_library.mdx b/versioned_docs/version-2.3/reference/targets/python_requirement_library.mdx index b1e07ee2c..892d34e56 100644 --- a/versioned_docs/version-2.3/reference/targets/python_requirement_library.mdx +++ b/versioned_docs/version-2.3/reference/targets/python_requirement_library.mdx @@ -1,5 +1,7 @@ --- title: python_requirement_library +description: | + Python requirements installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/python_tests.mdx b/versioned_docs/version-2.3/reference/targets/python_tests.mdx index c1c1b1f1a..53eb897e7 100644 --- a/versioned_docs/version-2.3/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.3/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Python tests, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/relocated_files.mdx b/versioned_docs/version-2.3/reference/targets/relocated_files.mdx index eec235076..1c86b8ec1 100644 --- a/versioned_docs/version-2.3/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.3/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/resources.mdx b/versioned_docs/version-2.3/reference/targets/resources.mdx index 1768d9b1e..dab35cb45 100644 --- a/versioned_docs/version-2.3/reference/targets/resources.mdx +++ b/versioned_docs/version-2.3/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Data embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.3/reference/targets/target.mdx b/versioned_docs/version-2.3/reference/targets/target.mdx index 00c179219..65f862e7d 100644 --- a/versioned_docs/version-2.3/reference/targets/target.mdx +++ b/versioned_docs/version-2.3/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/global-options.mdx b/versioned_docs/version-2.4/reference/global-options.mdx index 577ace2de..e9ac6853d 100644 --- a/versioned_docs/version-2.4/reference/global-options.mdx +++ b/versioned_docs/version-2.4/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/count-loc.mdx b/versioned_docs/version-2.4/reference/goals/count-loc.mdx index 61b94f521..96cb7d6d8 100644 --- a/versioned_docs/version-2.4/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.4/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/dependees.mdx b/versioned_docs/version-2.4/reference/goals/dependees.mdx index d90ac55ea..30c6e3af2 100644 --- a/versioned_docs/version-2.4/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.4/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/dependencies.mdx b/versioned_docs/version-2.4/reference/goals/dependencies.mdx index 8042a2072..02b9498e2 100644 --- a/versioned_docs/version-2.4/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.4/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/export-codegen.mdx b/versioned_docs/version-2.4/reference/goals/export-codegen.mdx index 178ee2c6e..4037a1f60 100644 --- a/versioned_docs/version-2.4/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.4/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/filedeps.mdx b/versioned_docs/version-2.4/reference/goals/filedeps.mdx index 91a1ba849..a978c874b 100644 --- a/versioned_docs/version-2.4/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.4/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/filter.mdx b/versioned_docs/version-2.4/reference/goals/filter.mdx index 58c7d0420..921460b84 100644 --- a/versioned_docs/version-2.4/reference/goals/filter.mdx +++ b/versioned_docs/version-2.4/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/fmt.mdx b/versioned_docs/version-2.4/reference/goals/fmt.mdx index 8ca8ffe1b..b107b8840 100644 --- a/versioned_docs/version-2.4/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.4/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/lint.mdx b/versioned_docs/version-2.4/reference/goals/lint.mdx index 578308f09..00bd3e1da 100644 --- a/versioned_docs/version-2.4/reference/goals/lint.mdx +++ b/versioned_docs/version-2.4/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/list.mdx b/versioned_docs/version-2.4/reference/goals/list.mdx index a0728060b..255a7d00c 100644 --- a/versioned_docs/version-2.4/reference/goals/list.mdx +++ b/versioned_docs/version-2.4/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/package.mdx b/versioned_docs/version-2.4/reference/goals/package.mdx index 55b0f3c6c..13c41a580 100644 --- a/versioned_docs/version-2.4/reference/goals/package.mdx +++ b/versioned_docs/version-2.4/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/py-constraints.mdx b/versioned_docs/version-2.4/reference/goals/py-constraints.mdx index ea5f8d941..9ae269396 100644 --- a/versioned_docs/version-2.4/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.4/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/repl.mdx b/versioned_docs/version-2.4/reference/goals/repl.mdx index 680ea79f2..36642f3b6 100644 --- a/versioned_docs/version-2.4/reference/goals/repl.mdx +++ b/versioned_docs/version-2.4/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/roots.mdx b/versioned_docs/version-2.4/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.4/reference/goals/roots.mdx +++ b/versioned_docs/version-2.4/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/run.mdx b/versioned_docs/version-2.4/reference/goals/run.mdx index ea3587523..8a367c776 100644 --- a/versioned_docs/version-2.4/reference/goals/run.mdx +++ b/versioned_docs/version-2.4/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/tailor.mdx b/versioned_docs/version-2.4/reference/goals/tailor.mdx index 565af390b..b92f4933f 100644 --- a/versioned_docs/version-2.4/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.4/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/test.mdx b/versioned_docs/version-2.4/reference/goals/test.mdx index 82456d163..8079855a1 100644 --- a/versioned_docs/version-2.4/reference/goals/test.mdx +++ b/versioned_docs/version-2.4/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/typecheck.mdx b/versioned_docs/version-2.4/reference/goals/typecheck.mdx index 6a75ad6db..f31d36046 100644 --- a/versioned_docs/version-2.4/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.4/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checkers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/goals/validate.mdx b/versioned_docs/version-2.4/reference/goals/validate.mdx index 71c52e21f..db2f473d1 100644 --- a/versioned_docs/version-2.4/reference/goals/validate.mdx +++ b/versioned_docs/version-2.4/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.4/reference/subsystems/anonymous-telemetry.mdx index 8763150eb..b648865e4 100644 --- a/versioned_docs/version-2.4/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/bandit.mdx b/versioned_docs/version-2.4/reference/subsystems/bandit.mdx index 2db7d861f..ea167cac2 100644 --- a/versioned_docs/version-2.4/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/black.mdx b/versioned_docs/version-2.4/reference/subsystems/black.mdx index 69f8469ef..26d5c3165 100644 --- a/versioned_docs/version-2.4/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/changed.mdx b/versioned_docs/version-2.4/reference/subsystems/changed.mdx index b9166f2ba..19a9f4472 100644 --- a/versioned_docs/version-2.4/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.4/reference/subsystems/coverage-py.mdx index c2beda1ce..6b0ad763d 100644 --- a/versioned_docs/version-2.4/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.4/reference/subsystems/docformatter.mdx index 1c1da2c2b..05c86461e 100644 --- a/versioned_docs/version-2.4/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.4/reference/subsystems/download-pex-bin.mdx index 4b43fd513..b220cb5d6 100644 --- a/versioned_docs/version-2.4/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/flake8.mdx b/versioned_docs/version-2.4/reference/subsystems/flake8.mdx index 5f665cbf8..aba49b795 100644 --- a/versioned_docs/version-2.4/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/grpc_python_plugin.mdx b/versioned_docs/version-2.4/reference/subsystems/grpc_python_plugin.mdx index e7a18fd5b..c4b9512f4 100644 --- a/versioned_docs/version-2.4/reference/subsystems/grpc_python_plugin.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/grpc_python_plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc_python_plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/ipython.mdx b/versioned_docs/version-2.4/reference/subsystems/ipython.mdx index 25df8d761..a0ab7c1ec 100644 --- a/versioned_docs/version-2.4/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/isort.mdx b/versioned_docs/version-2.4/reference/subsystems/isort.mdx index cb5fc0694..f8e12e29f 100644 --- a/versioned_docs/version-2.4/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://timothycrosley.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.4/reference/subsystems/lambdex.mdx index 836dc17d3..5166ac602 100644 --- a/versioned_docs/version-2.4/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into AWS Lambdas (https://github.com/wickman/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/mypy.mdx b/versioned_docs/version-2.4/reference/subsystems/mypy.mdx index ce51f9e20..c6da0e153 100644 --- a/versioned_docs/version-2.4/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.4/reference/subsystems/pex-binary-defaults.mdx index f439d5d21..f47a724a4 100644 --- a/versioned_docs/version-2.4/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/pex.mdx b/versioned_docs/version-2.4/reference/subsystems/pex.mdx index 6d6d56704..1f86d9ecc 100644 --- a/versioned_docs/version-2.4/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/protoc.mdx b/versioned_docs/version-2.4/reference/subsystems/protoc.mdx index 6d9fe83d0..1acc0fed1 100644 --- a/versioned_docs/version-2.4/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/pylint.mdx b/versioned_docs/version-2.4/reference/subsystems/pylint.mdx index be59d0562..ed8455c71 100644 --- a/versioned_docs/version-2.4/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/pytest.mdx b/versioned_docs/version-2.4/reference/subsystems/pytest.mdx index 20e6cac0e..27b4b50d8 100644 --- a/versioned_docs/version-2.4/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.4/reference/subsystems/python-infer.mdx index bcc5d7d18..77bd226d5 100644 --- a/versioned_docs/version-2.4/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.4/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.4/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.4/reference/subsystems/python-protobuf.mdx index eaceafaf5..faa795995 100644 --- a/versioned_docs/version-2.4/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/python-protobuf.mypy-plugin.mdx b/versioned_docs/version-2.4/reference/subsystems/python-protobuf.mypy-plugin.mdx index 682579f0a..78a9de920 100644 --- a/versioned_docs/version-2.4/reference/subsystems/python-protobuf.mypy-plugin.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/python-protobuf.mypy-plugin.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf.mypy-plugin +description: | + Configuration of the mypy-protobuf type stub generation plugin for the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.4/reference/subsystems/python-repos.mdx index 9251d2c4e..bee1ff73f 100644 --- a/versioned_docs/version-2.4/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.4/reference/subsystems/python-setup.mdx index 094b32f32..0807addd8 100644 --- a/versioned_docs/version-2.4/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + Options for Pants's Python support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/scc.mdx b/versioned_docs/version-2.4/reference/subsystems/scc.mdx index 469084292..4a9a82b85 100644 --- a/versioned_docs/version-2.4/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.4/reference/subsystems/setup-py-generation.mdx index 5b4cd4e97..8dcae9a51 100644 --- a/versioned_docs/version-2.4/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.4/reference/subsystems/setuptools.mdx index 97f1d820e..7be6148a7 100644 --- a/versioned_docs/version-2.4/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + The Python setuptools library (https://github.com/pypa/setuptools). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/source.mdx b/versioned_docs/version-2.4/reference/subsystems/source.mdx index ec3d00134..01a1bb640 100644 --- a/versioned_docs/version-2.4/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.4/reference/subsystems/sourcefile-validation.mdx index 6e58015a8..8c61abda2 100644 --- a/versioned_docs/version-2.4/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/stats.mdx b/versioned_docs/version-2.4/reference/subsystems/stats.mdx index ff9788f19..4beb56117 100644 --- a/versioned_docs/version-2.4/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.4/reference/subsystems/subprocess-environment.mdx index 10f6580b4..17ba0a093 100644 --- a/versioned_docs/version-2.4/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.4/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.4/reference/targets/archive.mdx b/versioned_docs/version-2.4/reference/targets/archive.mdx index 0050dd99d..648f311b2 100644 --- a/versioned_docs/version-2.4/reference/targets/archive.mdx +++ b/versioned_docs/version-2.4/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/files.mdx b/versioned_docs/version-2.4/reference/targets/files.mdx index 537f85d43..18cf314e7 100644 --- a/versioned_docs/version-2.4/reference/targets/files.mdx +++ b/versioned_docs/version-2.4/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Loose files that live outside code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/pex_binary.mdx b/versioned_docs/version-2.4/reference/targets/pex_binary.mdx index 5d9fee0f3..3207beb46 100644 --- a/versioned_docs/version-2.4/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.4/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/protobuf_library.mdx b/versioned_docs/version-2.4/reference/targets/protobuf_library.mdx index d71bcdc37..4b12fbaa3 100644 --- a/versioned_docs/version-2.4/reference/targets/protobuf_library.mdx +++ b/versioned_docs/version-2.4/reference/targets/protobuf_library.mdx @@ -1,5 +1,7 @@ --- title: protobuf_library +description: | + Protobuf files used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.4/reference/targets/python_awslambda.mdx index f22487075..f56283686 100644 --- a/versioned_docs/version-2.4/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.4/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/python_distribution.mdx b/versioned_docs/version-2.4/reference/targets/python_distribution.mdx index 538516730..ea6eae414 100644 --- a/versioned_docs/version-2.4/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.4/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/python_library.mdx b/versioned_docs/version-2.4/reference/targets/python_library.mdx index fc0ae4714..1b627b28d 100644 --- a/versioned_docs/version-2.4/reference/targets/python_library.mdx +++ b/versioned_docs/version-2.4/reference/targets/python_library.mdx @@ -1,5 +1,7 @@ --- title: python_library +description: | + Python source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/python_requirement_library.mdx b/versioned_docs/version-2.4/reference/targets/python_requirement_library.mdx index 93870c9c9..7e4e2e9b1 100644 --- a/versioned_docs/version-2.4/reference/targets/python_requirement_library.mdx +++ b/versioned_docs/version-2.4/reference/targets/python_requirement_library.mdx @@ -1,5 +1,7 @@ --- title: python_requirement_library +description: | + Python requirements installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/python_tests.mdx b/versioned_docs/version-2.4/reference/targets/python_tests.mdx index b93e1a9e6..36b6644c1 100644 --- a/versioned_docs/version-2.4/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.4/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Python tests, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/relocated_files.mdx b/versioned_docs/version-2.4/reference/targets/relocated_files.mdx index eec235076..1c86b8ec1 100644 --- a/versioned_docs/version-2.4/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.4/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/resources.mdx b/versioned_docs/version-2.4/reference/targets/resources.mdx index 1768d9b1e..dab35cb45 100644 --- a/versioned_docs/version-2.4/reference/targets/resources.mdx +++ b/versioned_docs/version-2.4/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Data embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.4/reference/targets/target.mdx b/versioned_docs/version-2.4/reference/targets/target.mdx index 00c179219..65f862e7d 100644 --- a/versioned_docs/version-2.4/reference/targets/target.mdx +++ b/versioned_docs/version-2.4/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/global-options.mdx b/versioned_docs/version-2.5/reference/global-options.mdx index b3bc2ee6a..da8f268b7 100644 --- a/versioned_docs/version-2.5/reference/global-options.mdx +++ b/versioned_docs/version-2.5/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/count-loc.mdx b/versioned_docs/version-2.5/reference/goals/count-loc.mdx index 42932ff52..62e9f5d92 100644 --- a/versioned_docs/version-2.5/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.5/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/dependees.mdx b/versioned_docs/version-2.5/reference/goals/dependees.mdx index 46c3c6a23..f55d5ddfb 100644 --- a/versioned_docs/version-2.5/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.5/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/dependencies.mdx b/versioned_docs/version-2.5/reference/goals/dependencies.mdx index 28bfed224..17e6e02bf 100644 --- a/versioned_docs/version-2.5/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.5/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/export-codegen.mdx b/versioned_docs/version-2.5/reference/goals/export-codegen.mdx index fd4a400ac..40689bff2 100644 --- a/versioned_docs/version-2.5/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.5/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/filedeps.mdx b/versioned_docs/version-2.5/reference/goals/filedeps.mdx index 979310441..0a61c89d0 100644 --- a/versioned_docs/version-2.5/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.5/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/filter.mdx b/versioned_docs/version-2.5/reference/goals/filter.mdx index 58c7d0420..921460b84 100644 --- a/versioned_docs/version-2.5/reference/goals/filter.mdx +++ b/versioned_docs/version-2.5/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/fmt.mdx b/versioned_docs/version-2.5/reference/goals/fmt.mdx index 7d0bc9f62..3d310a01d 100644 --- a/versioned_docs/version-2.5/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.5/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/lint.mdx b/versioned_docs/version-2.5/reference/goals/lint.mdx index e116deeb4..c61d759f6 100644 --- a/versioned_docs/version-2.5/reference/goals/lint.mdx +++ b/versioned_docs/version-2.5/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/list.mdx b/versioned_docs/version-2.5/reference/goals/list.mdx index a0728060b..255a7d00c 100644 --- a/versioned_docs/version-2.5/reference/goals/list.mdx +++ b/versioned_docs/version-2.5/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/package.mdx b/versioned_docs/version-2.5/reference/goals/package.mdx index d8d04d83e..fc93acfaf 100644 --- a/versioned_docs/version-2.5/reference/goals/package.mdx +++ b/versioned_docs/version-2.5/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/py-constraints.mdx b/versioned_docs/version-2.5/reference/goals/py-constraints.mdx index 358534ca9..aacbe53f3 100644 --- a/versioned_docs/version-2.5/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.5/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/repl.mdx b/versioned_docs/version-2.5/reference/goals/repl.mdx index ef4271118..455293c49 100644 --- a/versioned_docs/version-2.5/reference/goals/repl.mdx +++ b/versioned_docs/version-2.5/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/roots.mdx b/versioned_docs/version-2.5/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.5/reference/goals/roots.mdx +++ b/versioned_docs/version-2.5/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/run.mdx b/versioned_docs/version-2.5/reference/goals/run.mdx index 035cba209..be87fc66c 100644 --- a/versioned_docs/version-2.5/reference/goals/run.mdx +++ b/versioned_docs/version-2.5/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/tailor.mdx b/versioned_docs/version-2.5/reference/goals/tailor.mdx index 565af390b..b92f4933f 100644 --- a/versioned_docs/version-2.5/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.5/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/test.mdx b/versioned_docs/version-2.5/reference/goals/test.mdx index fe9797421..97a3eafbd 100644 --- a/versioned_docs/version-2.5/reference/goals/test.mdx +++ b/versioned_docs/version-2.5/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/typecheck.mdx b/versioned_docs/version-2.5/reference/goals/typecheck.mdx index 79700236c..deb448018 100644 --- a/versioned_docs/version-2.5/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.5/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checkers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/goals/validate.mdx b/versioned_docs/version-2.5/reference/goals/validate.mdx index fa77eb181..8d11e93e5 100644 --- a/versioned_docs/version-2.5/reference/goals/validate.mdx +++ b/versioned_docs/version-2.5/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.5/reference/subsystems/anonymous-telemetry.mdx index e4ecbfb9f..743dd76e7 100644 --- a/versioned_docs/version-2.5/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/bandit.mdx b/versioned_docs/version-2.5/reference/subsystems/bandit.mdx index aeaaf4b1a..57dd2642c 100644 --- a/versioned_docs/version-2.5/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/black.mdx b/versioned_docs/version-2.5/reference/subsystems/black.mdx index 4f8054243..6c8b4e499 100644 --- a/versioned_docs/version-2.5/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/changed.mdx b/versioned_docs/version-2.5/reference/subsystems/changed.mdx index 3ea42e555..0f67d7d04 100644 --- a/versioned_docs/version-2.5/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.5/reference/subsystems/coverage-py.mdx index ca24e6f53..df656da5e 100644 --- a/versioned_docs/version-2.5/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.5/reference/subsystems/docformatter.mdx index 4e8b8dd24..720ae18a8 100644 --- a/versioned_docs/version-2.5/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.5/reference/subsystems/download-pex-bin.mdx index 4031d0805..636d13f1a 100644 --- a/versioned_docs/version-2.5/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/flake8.mdx b/versioned_docs/version-2.5/reference/subsystems/flake8.mdx index 395026c5c..fa2cb9b16 100644 --- a/versioned_docs/version-2.5/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/grpc_python_plugin.mdx b/versioned_docs/version-2.5/reference/subsystems/grpc_python_plugin.mdx index 5e7b8f2e4..4b22acaab 100644 --- a/versioned_docs/version-2.5/reference/subsystems/grpc_python_plugin.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/grpc_python_plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc_python_plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/ipython.mdx b/versioned_docs/version-2.5/reference/subsystems/ipython.mdx index 25df8d761..a0ab7c1ec 100644 --- a/versioned_docs/version-2.5/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/isort.mdx b/versioned_docs/version-2.5/reference/subsystems/isort.mdx index 6276eec9b..530b62933 100644 --- a/versioned_docs/version-2.5/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://timothycrosley.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.5/reference/subsystems/lambdex.mdx index ff47536f2..57e1d95b4 100644 --- a/versioned_docs/version-2.5/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into AWS Lambdas (https://github.com/wickman/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/mypy.mdx b/versioned_docs/version-2.5/reference/subsystems/mypy.mdx index 28a1cfded..6d3b65a26 100644 --- a/versioned_docs/version-2.5/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.5/reference/subsystems/pex-binary-defaults.mdx index f439d5d21..f47a724a4 100644 --- a/versioned_docs/version-2.5/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/pex.mdx b/versioned_docs/version-2.5/reference/subsystems/pex.mdx index 6d6d56704..1f86d9ecc 100644 --- a/versioned_docs/version-2.5/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/protoc.mdx b/versioned_docs/version-2.5/reference/subsystems/protoc.mdx index e954d417a..705547341 100644 --- a/versioned_docs/version-2.5/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/pylint.mdx b/versioned_docs/version-2.5/reference/subsystems/pylint.mdx index 620f39bd7..ae4514fee 100644 --- a/versioned_docs/version-2.5/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/pytest.mdx b/versioned_docs/version-2.5/reference/subsystems/pytest.mdx index 71d8dfb57..10b18140c 100644 --- a/versioned_docs/version-2.5/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.5/reference/subsystems/python-infer.mdx index bcc5d7d18..77bd226d5 100644 --- a/versioned_docs/version-2.5/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.5/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.5/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.5/reference/subsystems/python-protobuf.mdx index 436472996..af71c5f1e 100644 --- a/versioned_docs/version-2.5/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/python-protobuf.mypy-plugin.mdx b/versioned_docs/version-2.5/reference/subsystems/python-protobuf.mypy-plugin.mdx index 7de36b92d..25f4c2308 100644 --- a/versioned_docs/version-2.5/reference/subsystems/python-protobuf.mypy-plugin.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/python-protobuf.mypy-plugin.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf.mypy-plugin +description: | + Configuration of the mypy-protobuf type stub generation plugin for the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.5/reference/subsystems/python-repos.mdx index 9251d2c4e..bee1ff73f 100644 --- a/versioned_docs/version-2.5/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.5/reference/subsystems/python-setup.mdx index 422b32364..57a28bf41 100644 --- a/versioned_docs/version-2.5/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + Options for Pants's Python support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/scc.mdx b/versioned_docs/version-2.5/reference/subsystems/scc.mdx index 5c3c5499f..0240f5801 100644 --- a/versioned_docs/version-2.5/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.5/reference/subsystems/setup-py-generation.mdx index 5b4cd4e97..8dcae9a51 100644 --- a/versioned_docs/version-2.5/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.5/reference/subsystems/setuptools.mdx index d648d59d9..e3e0411fa 100644 --- a/versioned_docs/version-2.5/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + The Python setuptools library (https://github.com/pypa/setuptools). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.5/reference/subsystems/shell-setup.mdx index b36794715..258adf20d 100644 --- a/versioned_docs/version-2.5/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.5/reference/subsystems/shellcheck.mdx index 559e0ddee..7df528b17 100644 --- a/versioned_docs/version-2.5/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.5/reference/subsystems/shfmt.mdx index f79adee6b..a73fbfece 100644 --- a/versioned_docs/version-2.5/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/source.mdx b/versioned_docs/version-2.5/reference/subsystems/source.mdx index 4edf3a04b..2c68d4cc1 100644 --- a/versioned_docs/version-2.5/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.5/reference/subsystems/sourcefile-validation.mdx index 6e58015a8..8c61abda2 100644 --- a/versioned_docs/version-2.5/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/stats.mdx b/versioned_docs/version-2.5/reference/subsystems/stats.mdx index ff9788f19..4beb56117 100644 --- a/versioned_docs/version-2.5/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.5/reference/subsystems/subprocess-environment.mdx index 10f6580b4..17ba0a093 100644 --- a/versioned_docs/version-2.5/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.5/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.5/reference/targets/archive.mdx b/versioned_docs/version-2.5/reference/targets/archive.mdx index 0050dd99d..648f311b2 100644 --- a/versioned_docs/version-2.5/reference/targets/archive.mdx +++ b/versioned_docs/version-2.5/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/files.mdx b/versioned_docs/version-2.5/reference/targets/files.mdx index 537f85d43..18cf314e7 100644 --- a/versioned_docs/version-2.5/reference/targets/files.mdx +++ b/versioned_docs/version-2.5/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Loose files that live outside code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/pex_binary.mdx b/versioned_docs/version-2.5/reference/targets/pex_binary.mdx index dd6784df3..97890fe31 100644 --- a/versioned_docs/version-2.5/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.5/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/protobuf_library.mdx b/versioned_docs/version-2.5/reference/targets/protobuf_library.mdx index 61937b23f..0f9f24f7c 100644 --- a/versioned_docs/version-2.5/reference/targets/protobuf_library.mdx +++ b/versioned_docs/version-2.5/reference/targets/protobuf_library.mdx @@ -1,5 +1,7 @@ --- title: protobuf_library +description: | + Protobuf files used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.5/reference/targets/python_awslambda.mdx index 29baf06fb..c87118f7e 100644 --- a/versioned_docs/version-2.5/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.5/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/python_distribution.mdx b/versioned_docs/version-2.5/reference/targets/python_distribution.mdx index 7b01ba7f6..0a84d841f 100644 --- a/versioned_docs/version-2.5/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.5/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/python_library.mdx b/versioned_docs/version-2.5/reference/targets/python_library.mdx index eb9de2bca..3786616d6 100644 --- a/versioned_docs/version-2.5/reference/targets/python_library.mdx +++ b/versioned_docs/version-2.5/reference/targets/python_library.mdx @@ -1,5 +1,7 @@ --- title: python_library +description: | + Python source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/python_requirement_library.mdx b/versioned_docs/version-2.5/reference/targets/python_requirement_library.mdx index 248c7a218..bdafa7b06 100644 --- a/versioned_docs/version-2.5/reference/targets/python_requirement_library.mdx +++ b/versioned_docs/version-2.5/reference/targets/python_requirement_library.mdx @@ -1,5 +1,7 @@ --- title: python_requirement_library +description: | + Python requirements installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/python_tests.mdx b/versioned_docs/version-2.5/reference/targets/python_tests.mdx index ac1e9eaa6..e9916ba1d 100644 --- a/versioned_docs/version-2.5/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.5/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Python tests, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/relocated_files.mdx b/versioned_docs/version-2.5/reference/targets/relocated_files.mdx index eec235076..1c86b8ec1 100644 --- a/versioned_docs/version-2.5/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.5/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/resources.mdx b/versioned_docs/version-2.5/reference/targets/resources.mdx index 1768d9b1e..dab35cb45 100644 --- a/versioned_docs/version-2.5/reference/targets/resources.mdx +++ b/versioned_docs/version-2.5/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Data embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/shell_library.mdx b/versioned_docs/version-2.5/reference/targets/shell_library.mdx index 83e1d91c6..c10504f58 100644 --- a/versioned_docs/version-2.5/reference/targets/shell_library.mdx +++ b/versioned_docs/version-2.5/reference/targets/shell_library.mdx @@ -1,5 +1,7 @@ --- title: shell_library +description: | + Bourne-based shell scripts, e.g. Bash scripts. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.5/reference/targets/shunit2_tests.mdx index 15051a3bf..fdd08546d 100644 --- a/versioned_docs/version-2.5/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.5/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Tests of Bourne-based shell scripts using the shUnit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.5/reference/targets/target.mdx b/versioned_docs/version-2.5/reference/targets/target.mdx index 00c179219..65f862e7d 100644 --- a/versioned_docs/version-2.5/reference/targets/target.mdx +++ b/versioned_docs/version-2.5/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/global-options.mdx b/versioned_docs/version-2.6/reference/global-options.mdx index 109dd2487..4a5f85dab 100644 --- a/versioned_docs/version-2.6/reference/global-options.mdx +++ b/versioned_docs/version-2.6/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/count-loc.mdx b/versioned_docs/version-2.6/reference/goals/count-loc.mdx index 42932ff52..62e9f5d92 100644 --- a/versioned_docs/version-2.6/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.6/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/dependees.mdx b/versioned_docs/version-2.6/reference/goals/dependees.mdx index 46c3c6a23..f55d5ddfb 100644 --- a/versioned_docs/version-2.6/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.6/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/dependencies.mdx b/versioned_docs/version-2.6/reference/goals/dependencies.mdx index 28bfed224..17e6e02bf 100644 --- a/versioned_docs/version-2.6/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.6/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/export-codegen.mdx b/versioned_docs/version-2.6/reference/goals/export-codegen.mdx index fd4a400ac..40689bff2 100644 --- a/versioned_docs/version-2.6/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.6/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/filedeps.mdx b/versioned_docs/version-2.6/reference/goals/filedeps.mdx index 979310441..0a61c89d0 100644 --- a/versioned_docs/version-2.6/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.6/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/filter.mdx b/versioned_docs/version-2.6/reference/goals/filter.mdx index 58c7d0420..921460b84 100644 --- a/versioned_docs/version-2.6/reference/goals/filter.mdx +++ b/versioned_docs/version-2.6/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/fmt.mdx b/versioned_docs/version-2.6/reference/goals/fmt.mdx index 7d0bc9f62..3d310a01d 100644 --- a/versioned_docs/version-2.6/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.6/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/lint.mdx b/versioned_docs/version-2.6/reference/goals/lint.mdx index 379f7020f..69dcfaf40 100644 --- a/versioned_docs/version-2.6/reference/goals/lint.mdx +++ b/versioned_docs/version-2.6/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/list.mdx b/versioned_docs/version-2.6/reference/goals/list.mdx index ced4e951e..6fedd4094 100644 --- a/versioned_docs/version-2.6/reference/goals/list.mdx +++ b/versioned_docs/version-2.6/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/package.mdx b/versioned_docs/version-2.6/reference/goals/package.mdx index d8d04d83e..fc93acfaf 100644 --- a/versioned_docs/version-2.6/reference/goals/package.mdx +++ b/versioned_docs/version-2.6/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/py-constraints.mdx b/versioned_docs/version-2.6/reference/goals/py-constraints.mdx index 358534ca9..aacbe53f3 100644 --- a/versioned_docs/version-2.6/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.6/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/repl.mdx b/versioned_docs/version-2.6/reference/goals/repl.mdx index ef4271118..455293c49 100644 --- a/versioned_docs/version-2.6/reference/goals/repl.mdx +++ b/versioned_docs/version-2.6/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/roots.mdx b/versioned_docs/version-2.6/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.6/reference/goals/roots.mdx +++ b/versioned_docs/version-2.6/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/run.mdx b/versioned_docs/version-2.6/reference/goals/run.mdx index 035cba209..be87fc66c 100644 --- a/versioned_docs/version-2.6/reference/goals/run.mdx +++ b/versioned_docs/version-2.6/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/tailor.mdx b/versioned_docs/version-2.6/reference/goals/tailor.mdx index be94cd5ef..8215d8ded 100644 --- a/versioned_docs/version-2.6/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.6/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/test.mdx b/versioned_docs/version-2.6/reference/goals/test.mdx index fe9797421..97a3eafbd 100644 --- a/versioned_docs/version-2.6/reference/goals/test.mdx +++ b/versioned_docs/version-2.6/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/typecheck.mdx b/versioned_docs/version-2.6/reference/goals/typecheck.mdx index 79700236c..deb448018 100644 --- a/versioned_docs/version-2.6/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.6/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checkers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/goals/validate.mdx b/versioned_docs/version-2.6/reference/goals/validate.mdx index fa77eb181..8d11e93e5 100644 --- a/versioned_docs/version-2.6/reference/goals/validate.mdx +++ b/versioned_docs/version-2.6/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.6/reference/subsystems/anonymous-telemetry.mdx index 8502fe9de..13d7b6b57 100644 --- a/versioned_docs/version-2.6/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/bandit.mdx b/versioned_docs/version-2.6/reference/subsystems/bandit.mdx index c8ed940b0..fde840b45 100644 --- a/versioned_docs/version-2.6/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/black.mdx b/versioned_docs/version-2.6/reference/subsystems/black.mdx index 1f641edcd..37f4bb23b 100644 --- a/versioned_docs/version-2.6/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/changed.mdx b/versioned_docs/version-2.6/reference/subsystems/changed.mdx index c57bbe208..33204520a 100644 --- a/versioned_docs/version-2.6/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.6/reference/subsystems/coverage-py.mdx index ca24e6f53..df656da5e 100644 --- a/versioned_docs/version-2.6/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.6/reference/subsystems/docformatter.mdx index 4e8b8dd24..720ae18a8 100644 --- a/versioned_docs/version-2.6/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.6/reference/subsystems/download-pex-bin.mdx index 4031d0805..636d13f1a 100644 --- a/versioned_docs/version-2.6/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/flake8.mdx b/versioned_docs/version-2.6/reference/subsystems/flake8.mdx index d399f0e9c..bad77238d 100644 --- a/versioned_docs/version-2.6/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/grpc_python_plugin.mdx b/versioned_docs/version-2.6/reference/subsystems/grpc_python_plugin.mdx index 5e7b8f2e4..4b22acaab 100644 --- a/versioned_docs/version-2.6/reference/subsystems/grpc_python_plugin.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/grpc_python_plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc_python_plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/ipython.mdx b/versioned_docs/version-2.6/reference/subsystems/ipython.mdx index 25df8d761..a0ab7c1ec 100644 --- a/versioned_docs/version-2.6/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/isort.mdx b/versioned_docs/version-2.6/reference/subsystems/isort.mdx index 6276eec9b..530b62933 100644 --- a/versioned_docs/version-2.6/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://timothycrosley.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.6/reference/subsystems/lambdex.mdx index ff47536f2..57e1d95b4 100644 --- a/versioned_docs/version-2.6/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into AWS Lambdas (https://github.com/wickman/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/mypy.mdx b/versioned_docs/version-2.6/reference/subsystems/mypy.mdx index aa9614676..8d7276d54 100644 --- a/versioned_docs/version-2.6/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.6/reference/subsystems/pex-binary-defaults.mdx index f439d5d21..f47a724a4 100644 --- a/versioned_docs/version-2.6/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/pex.mdx b/versioned_docs/version-2.6/reference/subsystems/pex.mdx index 6d6d56704..1f86d9ecc 100644 --- a/versioned_docs/version-2.6/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/protoc.mdx b/versioned_docs/version-2.6/reference/subsystems/protoc.mdx index e954d417a..705547341 100644 --- a/versioned_docs/version-2.6/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/pylint.mdx b/versioned_docs/version-2.6/reference/subsystems/pylint.mdx index 3df36af02..c43d93e7b 100644 --- a/versioned_docs/version-2.6/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/pytest.mdx b/versioned_docs/version-2.6/reference/subsystems/pytest.mdx index ad45a0475..0e7f49484 100644 --- a/versioned_docs/version-2.6/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.6/reference/subsystems/python-infer.mdx index bcc5d7d18..77bd226d5 100644 --- a/versioned_docs/version-2.6/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.6/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.6/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.6/reference/subsystems/python-protobuf.mdx index 07bc08a55..e5942506a 100644 --- a/versioned_docs/version-2.6/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/python-protobuf.mypy-plugin.mdx b/versioned_docs/version-2.6/reference/subsystems/python-protobuf.mypy-plugin.mdx index 7de36b92d..25f4c2308 100644 --- a/versioned_docs/version-2.6/reference/subsystems/python-protobuf.mypy-plugin.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/python-protobuf.mypy-plugin.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf.mypy-plugin +description: | + Configuration of the mypy-protobuf type stub generation plugin for the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.6/reference/subsystems/python-repos.mdx index 9251d2c4e..bee1ff73f 100644 --- a/versioned_docs/version-2.6/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.6/reference/subsystems/python-setup.mdx index ac455ea34..67ebacc78 100644 --- a/versioned_docs/version-2.6/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + Options for Pants's Python support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/scc.mdx b/versioned_docs/version-2.6/reference/subsystems/scc.mdx index 5c3c5499f..0240f5801 100644 --- a/versioned_docs/version-2.6/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.6/reference/subsystems/setup-py-generation.mdx index 5b4cd4e97..8dcae9a51 100644 --- a/versioned_docs/version-2.6/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.6/reference/subsystems/setuptools.mdx index d648d59d9..e3e0411fa 100644 --- a/versioned_docs/version-2.6/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + The Python setuptools library (https://github.com/pypa/setuptools). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.6/reference/subsystems/shell-setup.mdx index b36794715..258adf20d 100644 --- a/versioned_docs/version-2.6/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.6/reference/subsystems/shellcheck.mdx index 559e0ddee..7df528b17 100644 --- a/versioned_docs/version-2.6/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.6/reference/subsystems/shfmt.mdx index f79adee6b..a73fbfece 100644 --- a/versioned_docs/version-2.6/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/source.mdx b/versioned_docs/version-2.6/reference/subsystems/source.mdx index 0e009947f..298b558ff 100644 --- a/versioned_docs/version-2.6/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.6/reference/subsystems/sourcefile-validation.mdx index 6e58015a8..8c61abda2 100644 --- a/versioned_docs/version-2.6/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/stats.mdx b/versioned_docs/version-2.6/reference/subsystems/stats.mdx index ff9788f19..4beb56117 100644 --- a/versioned_docs/version-2.6/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.6/reference/subsystems/subprocess-environment.mdx index 10f6580b4..17ba0a093 100644 --- a/versioned_docs/version-2.6/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.6/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.6/reference/targets/archive.mdx b/versioned_docs/version-2.6/reference/targets/archive.mdx index 0050dd99d..648f311b2 100644 --- a/versioned_docs/version-2.6/reference/targets/archive.mdx +++ b/versioned_docs/version-2.6/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/files.mdx b/versioned_docs/version-2.6/reference/targets/files.mdx index 537f85d43..18cf314e7 100644 --- a/versioned_docs/version-2.6/reference/targets/files.mdx +++ b/versioned_docs/version-2.6/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Loose files that live outside code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/pex_binary.mdx b/versioned_docs/version-2.6/reference/targets/pex_binary.mdx index 946ad7de5..00f99dd7b 100644 --- a/versioned_docs/version-2.6/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.6/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/protobuf_library.mdx b/versioned_docs/version-2.6/reference/targets/protobuf_library.mdx index 2ed43daf2..c79eb925f 100644 --- a/versioned_docs/version-2.6/reference/targets/protobuf_library.mdx +++ b/versioned_docs/version-2.6/reference/targets/protobuf_library.mdx @@ -1,5 +1,7 @@ --- title: protobuf_library +description: | + Protobuf files used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.6/reference/targets/python_awslambda.mdx index e97c071f3..5a20fca38 100644 --- a/versioned_docs/version-2.6/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.6/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/python_distribution.mdx b/versioned_docs/version-2.6/reference/targets/python_distribution.mdx index a097fb1db..d27db5809 100644 --- a/versioned_docs/version-2.6/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.6/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/python_library.mdx b/versioned_docs/version-2.6/reference/targets/python_library.mdx index 7a2a5d3ad..b9dc071be 100644 --- a/versioned_docs/version-2.6/reference/targets/python_library.mdx +++ b/versioned_docs/version-2.6/reference/targets/python_library.mdx @@ -1,5 +1,7 @@ --- title: python_library +description: | + Python source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/python_requirement_library.mdx b/versioned_docs/version-2.6/reference/targets/python_requirement_library.mdx index dffa2dd7d..cb6de08a9 100644 --- a/versioned_docs/version-2.6/reference/targets/python_requirement_library.mdx +++ b/versioned_docs/version-2.6/reference/targets/python_requirement_library.mdx @@ -1,5 +1,7 @@ --- title: python_requirement_library +description: | + Python requirements installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/python_tests.mdx b/versioned_docs/version-2.6/reference/targets/python_tests.mdx index a0b3ddd91..db2e299e5 100644 --- a/versioned_docs/version-2.6/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.6/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Python tests, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/relocated_files.mdx b/versioned_docs/version-2.6/reference/targets/relocated_files.mdx index 4d8a41f95..d6584415a 100644 --- a/versioned_docs/version-2.6/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.6/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/resources.mdx b/versioned_docs/version-2.6/reference/targets/resources.mdx index 1768d9b1e..dab35cb45 100644 --- a/versioned_docs/version-2.6/reference/targets/resources.mdx +++ b/versioned_docs/version-2.6/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Data embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/shell_library.mdx b/versioned_docs/version-2.6/reference/targets/shell_library.mdx index 83e1d91c6..c10504f58 100644 --- a/versioned_docs/version-2.6/reference/targets/shell_library.mdx +++ b/versioned_docs/version-2.6/reference/targets/shell_library.mdx @@ -1,5 +1,7 @@ --- title: shell_library +description: | + Bourne-based shell scripts, e.g. Bash scripts. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.6/reference/targets/shunit2_tests.mdx index 15051a3bf..fdd08546d 100644 --- a/versioned_docs/version-2.6/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.6/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Tests of Bourne-based shell scripts using the shUnit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.6/reference/targets/target.mdx b/versioned_docs/version-2.6/reference/targets/target.mdx index 00c179219..65f862e7d 100644 --- a/versioned_docs/version-2.6/reference/targets/target.mdx +++ b/versioned_docs/version-2.6/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/global-options.mdx b/versioned_docs/version-2.7/reference/global-options.mdx index 2628242bb..2abc697e9 100644 --- a/versioned_docs/version-2.7/reference/global-options.mdx +++ b/versioned_docs/version-2.7/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/count-loc.mdx b/versioned_docs/version-2.7/reference/goals/count-loc.mdx index f52a30a2f..11be60c0d 100644 --- a/versioned_docs/version-2.7/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.7/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/dependees.mdx b/versioned_docs/version-2.7/reference/goals/dependees.mdx index f53684408..1b9a105b2 100644 --- a/versioned_docs/version-2.7/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.7/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/dependencies.mdx b/versioned_docs/version-2.7/reference/goals/dependencies.mdx index 39c653d35..5ff38438c 100644 --- a/versioned_docs/version-2.7/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.7/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/export-codegen.mdx b/versioned_docs/version-2.7/reference/goals/export-codegen.mdx index 3c408e03f..bf806a8e6 100644 --- a/versioned_docs/version-2.7/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.7/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/filedeps.mdx b/versioned_docs/version-2.7/reference/goals/filedeps.mdx index 09d412917..6ee37bf6d 100644 --- a/versioned_docs/version-2.7/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.7/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/filter.mdx b/versioned_docs/version-2.7/reference/goals/filter.mdx index 58c7d0420..921460b84 100644 --- a/versioned_docs/version-2.7/reference/goals/filter.mdx +++ b/versioned_docs/version-2.7/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/fmt.mdx b/versioned_docs/version-2.7/reference/goals/fmt.mdx index 9ad5e76d9..71fea8507 100644 --- a/versioned_docs/version-2.7/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.7/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.7/reference/goals/generate-lockfiles.mdx index 018edf15e..79887df12 100644 --- a/versioned_docs/version-2.7/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.7/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for Python third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/generate-user-lockfile.mdx b/versioned_docs/version-2.7/reference/goals/generate-user-lockfile.mdx index 47394ab69..9631c1f84 100644 --- a/versioned_docs/version-2.7/reference/goals/generate-user-lockfile.mdx +++ b/versioned_docs/version-2.7/reference/goals/generate-user-lockfile.mdx @@ -1,5 +1,7 @@ --- title: generate-user-lockfile +description: | + Generate a lockfile for Python user requirements (experimental). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/lint.mdx b/versioned_docs/version-2.7/reference/goals/lint.mdx index 7b9f9e41d..55ff07a0d 100644 --- a/versioned_docs/version-2.7/reference/goals/lint.mdx +++ b/versioned_docs/version-2.7/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/list.mdx b/versioned_docs/version-2.7/reference/goals/list.mdx index ced4e951e..6fedd4094 100644 --- a/versioned_docs/version-2.7/reference/goals/list.mdx +++ b/versioned_docs/version-2.7/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/package.mdx b/versioned_docs/version-2.7/reference/goals/package.mdx index d03c6aaba..fc76e7847 100644 --- a/versioned_docs/version-2.7/reference/goals/package.mdx +++ b/versioned_docs/version-2.7/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/peek.mdx b/versioned_docs/version-2.7/reference/goals/peek.mdx index e2400e2b0..c60a8f39d 100644 --- a/versioned_docs/version-2.7/reference/goals/peek.mdx +++ b/versioned_docs/version-2.7/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/py-constraints.mdx b/versioned_docs/version-2.7/reference/goals/py-constraints.mdx index 39a716f74..c0a6c08ff 100644 --- a/versioned_docs/version-2.7/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.7/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/repl.mdx b/versioned_docs/version-2.7/reference/goals/repl.mdx index 0dfdc71c6..11f6a9c48 100644 --- a/versioned_docs/version-2.7/reference/goals/repl.mdx +++ b/versioned_docs/version-2.7/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/roots.mdx b/versioned_docs/version-2.7/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.7/reference/goals/roots.mdx +++ b/versioned_docs/version-2.7/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/run.mdx b/versioned_docs/version-2.7/reference/goals/run.mdx index ceee07bfa..1506e1401 100644 --- a/versioned_docs/version-2.7/reference/goals/run.mdx +++ b/versioned_docs/version-2.7/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/tailor.mdx b/versioned_docs/version-2.7/reference/goals/tailor.mdx index 3e7535de2..34dfcbe7b 100644 --- a/versioned_docs/version-2.7/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.7/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/test.mdx b/versioned_docs/version-2.7/reference/goals/test.mdx index 683356329..0ab18dd09 100644 --- a/versioned_docs/version-2.7/reference/goals/test.mdx +++ b/versioned_docs/version-2.7/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/typecheck.mdx b/versioned_docs/version-2.7/reference/goals/typecheck.mdx index feddb5e0c..7a7856272 100644 --- a/versioned_docs/version-2.7/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.7/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checkers. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/goals/validate.mdx b/versioned_docs/version-2.7/reference/goals/validate.mdx index f76ca3b40..ee9ed0378 100644 --- a/versioned_docs/version-2.7/reference/goals/validate.mdx +++ b/versioned_docs/version-2.7/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.7/reference/subsystems/anonymous-telemetry.mdx index 92d9c2f89..67a1c0496 100644 --- a/versioned_docs/version-2.7/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/bandit.mdx b/versioned_docs/version-2.7/reference/subsystems/bandit.mdx index 5ec29d24b..7f6dbe115 100644 --- a/versioned_docs/version-2.7/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/black.mdx b/versioned_docs/version-2.7/reference/subsystems/black.mdx index 1bf887b72..a3e1ae69d 100644 --- a/versioned_docs/version-2.7/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/changed.mdx b/versioned_docs/version-2.7/reference/subsystems/changed.mdx index 349a50c55..d403f785a 100644 --- a/versioned_docs/version-2.7/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.7/reference/subsystems/coverage-py.mdx index fc189a3e0..afee0330e 100644 --- a/versioned_docs/version-2.7/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.7/reference/subsystems/docformatter.mdx index d3578f907..2f36dec10 100644 --- a/versioned_docs/version-2.7/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.7/reference/subsystems/download-pex-bin.mdx index 6f69fcbbe..11a097b52 100644 --- a/versioned_docs/version-2.7/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/flake8.mdx b/versioned_docs/version-2.7/reference/subsystems/flake8.mdx index 4e14eee13..764a5f148 100644 --- a/versioned_docs/version-2.7/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.7/reference/subsystems/grpc-python-plugin.mdx index 1032912cc..e339d1270 100644 --- a/versioned_docs/version-2.7/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/grpc_python_plugin.mdx b/versioned_docs/version-2.7/reference/subsystems/grpc_python_plugin.mdx index 68911c2f3..5ce94e8ef 100644 --- a/versioned_docs/version-2.7/reference/subsystems/grpc_python_plugin.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/grpc_python_plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc_python_plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/ipython.mdx b/versioned_docs/version-2.7/reference/subsystems/ipython.mdx index 93bda6402..5a1afeb67 100644 --- a/versioned_docs/version-2.7/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/isort.mdx b/versioned_docs/version-2.7/reference/subsystems/isort.mdx index dd7961865..7a40a3793 100644 --- a/versioned_docs/version-2.7/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://timothycrosley.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.7/reference/subsystems/lambdex.mdx index e04377bd4..99fe03bba 100644 --- a/versioned_docs/version-2.7/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into AWS Lambdas (https://github.com/wickman/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.7/reference/subsystems/mypy-protobuf.mdx index fd397ee41..6eeba6d24 100644 --- a/versioned_docs/version-2.7/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/mypy.mdx b/versioned_docs/version-2.7/reference/subsystems/mypy.mdx index 028b76dd5..999dcc477 100644 --- a/versioned_docs/version-2.7/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.7/reference/subsystems/pex-binary-defaults.mdx index f439d5d21..f47a724a4 100644 --- a/versioned_docs/version-2.7/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/pex.mdx b/versioned_docs/version-2.7/reference/subsystems/pex.mdx index 6d6d56704..1f86d9ecc 100644 --- a/versioned_docs/version-2.7/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/poetry.mdx b/versioned_docs/version-2.7/reference/subsystems/poetry.mdx index b95c24663..d462f92be 100644 --- a/versioned_docs/version-2.7/reference/subsystems/poetry.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/poetry.mdx @@ -1,5 +1,7 @@ --- title: poetry +description: | + Used to generate lockfiles for third-party Python dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/protoc.mdx b/versioned_docs/version-2.7/reference/subsystems/protoc.mdx index d0b8b8d9c..d07fc1e70 100644 --- a/versioned_docs/version-2.7/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/pylint.mdx b/versioned_docs/version-2.7/reference/subsystems/pylint.mdx index cdcd91f2b..0f867ec4f 100644 --- a/versioned_docs/version-2.7/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/pytest.mdx b/versioned_docs/version-2.7/reference/subsystems/pytest.mdx index 1e43bc7af..9558ea55f 100644 --- a/versioned_docs/version-2.7/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.7/reference/subsystems/python-infer.mdx index a015e5581..d906fb881 100644 --- a/versioned_docs/version-2.7/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.7/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.7/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.7/reference/subsystems/python-protobuf.mdx index 50f5bb8e4..770dd0e06 100644 --- a/versioned_docs/version-2.7/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/python-protobuf.mypy-plugin.mdx b/versioned_docs/version-2.7/reference/subsystems/python-protobuf.mypy-plugin.mdx index e7f31787f..797a5a0aa 100644 --- a/versioned_docs/version-2.7/reference/subsystems/python-protobuf.mypy-plugin.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/python-protobuf.mypy-plugin.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf.mypy-plugin +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.7/reference/subsystems/python-repos.mdx index 9251d2c4e..bee1ff73f 100644 --- a/versioned_docs/version-2.7/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.7/reference/subsystems/python-setup.mdx index 1cd634386..e02dc0625 100644 --- a/versioned_docs/version-2.7/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + Options for Pants's Python support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/scc.mdx b/versioned_docs/version-2.7/reference/subsystems/scc.mdx index d6ad0c26f..07f24fab3 100644 --- a/versioned_docs/version-2.7/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.7/reference/subsystems/setup-py-generation.mdx index 5b4cd4e97..8dcae9a51 100644 --- a/versioned_docs/version-2.7/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.7/reference/subsystems/setuptools.mdx index ee582269f..27e7120b8 100644 --- a/versioned_docs/version-2.7/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.7/reference/subsystems/shell-setup.mdx index b36794715..258adf20d 100644 --- a/versioned_docs/version-2.7/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.7/reference/subsystems/shellcheck.mdx index 00c5332d6..72cdfca8a 100644 --- a/versioned_docs/version-2.7/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.7/reference/subsystems/shfmt.mdx index 67fae4dc0..5c7c0a426 100644 --- a/versioned_docs/version-2.7/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/source.mdx b/versioned_docs/version-2.7/reference/subsystems/source.mdx index e212d59df..f930c3924 100644 --- a/versioned_docs/version-2.7/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.7/reference/subsystems/sourcefile-validation.mdx index 6e58015a8..8c61abda2 100644 --- a/versioned_docs/version-2.7/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/stats.mdx b/versioned_docs/version-2.7/reference/subsystems/stats.mdx index ff9788f19..4beb56117 100644 --- a/versioned_docs/version-2.7/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.7/reference/subsystems/subprocess-environment.mdx index 10f6580b4..17ba0a093 100644 --- a/versioned_docs/version-2.7/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/subsystems/yapf.mdx b/versioned_docs/version-2.7/reference/subsystems/yapf.mdx index a5a70a42d..702935beb 100644 --- a/versioned_docs/version-2.7/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.7/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.7/reference/targets/archive.mdx b/versioned_docs/version-2.7/reference/targets/archive.mdx index 0050dd99d..648f311b2 100644 --- a/versioned_docs/version-2.7/reference/targets/archive.mdx +++ b/versioned_docs/version-2.7/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/docker_image.mdx b/versioned_docs/version-2.7/reference/targets/docker_image.mdx index 81b317b58..ec9f1a943 100644 --- a/versioned_docs/version-2.7/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.7/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + A Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/files.mdx b/versioned_docs/version-2.7/reference/targets/files.mdx index 537f85d43..18cf314e7 100644 --- a/versioned_docs/version-2.7/reference/targets/files.mdx +++ b/versioned_docs/version-2.7/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Loose files that live outside code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/pex_binary.mdx b/versioned_docs/version-2.7/reference/targets/pex_binary.mdx index c9787757f..0599a5f1c 100644 --- a/versioned_docs/version-2.7/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.7/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/protobuf_library.mdx b/versioned_docs/version-2.7/reference/targets/protobuf_library.mdx index 87b978099..181490251 100644 --- a/versioned_docs/version-2.7/reference/targets/protobuf_library.mdx +++ b/versioned_docs/version-2.7/reference/targets/protobuf_library.mdx @@ -1,5 +1,7 @@ --- title: protobuf_library +description: | + Protobuf files used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.7/reference/targets/python_awslambda.mdx index e10056ba6..d8ceee888 100644 --- a/versioned_docs/version-2.7/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.7/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/python_distribution.mdx b/versioned_docs/version-2.7/reference/targets/python_distribution.mdx index 173619f43..e5f93d0da 100644 --- a/versioned_docs/version-2.7/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.7/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/python_library.mdx b/versioned_docs/version-2.7/reference/targets/python_library.mdx index 4402d1f0d..f4e1143c1 100644 --- a/versioned_docs/version-2.7/reference/targets/python_library.mdx +++ b/versioned_docs/version-2.7/reference/targets/python_library.mdx @@ -1,5 +1,7 @@ --- title: python_library +description: | + Python source code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/python_requirement_library.mdx b/versioned_docs/version-2.7/reference/targets/python_requirement_library.mdx index 199bbfd44..7f2be854d 100644 --- a/versioned_docs/version-2.7/reference/targets/python_requirement_library.mdx +++ b/versioned_docs/version-2.7/reference/targets/python_requirement_library.mdx @@ -1,5 +1,7 @@ --- title: python_requirement_library +description: | + Python requirements installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/python_tests.mdx b/versioned_docs/version-2.7/reference/targets/python_tests.mdx index 17299d411..d43cfc586 100644 --- a/versioned_docs/version-2.7/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.7/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Python tests, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/relocated_files.mdx b/versioned_docs/version-2.7/reference/targets/relocated_files.mdx index 4d8a41f95..d6584415a 100644 --- a/versioned_docs/version-2.7/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.7/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/resources.mdx b/versioned_docs/version-2.7/reference/targets/resources.mdx index 1768d9b1e..dab35cb45 100644 --- a/versioned_docs/version-2.7/reference/targets/resources.mdx +++ b/versioned_docs/version-2.7/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Data embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/shell_library.mdx b/versioned_docs/version-2.7/reference/targets/shell_library.mdx index 83e1d91c6..c10504f58 100644 --- a/versioned_docs/version-2.7/reference/targets/shell_library.mdx +++ b/versioned_docs/version-2.7/reference/targets/shell_library.mdx @@ -1,5 +1,7 @@ --- title: shell_library +description: | + Bourne-based shell scripts, e.g. Bash scripts. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.7/reference/targets/shunit2_tests.mdx index 15051a3bf..fdd08546d 100644 --- a/versioned_docs/version-2.7/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.7/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Tests of Bourne-based shell scripts using the shUnit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.7/reference/targets/target.mdx b/versioned_docs/version-2.7/reference/targets/target.mdx index 00c179219..65f862e7d 100644 --- a/versioned_docs/version-2.7/reference/targets/target.mdx +++ b/versioned_docs/version-2.7/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/global-options.mdx b/versioned_docs/version-2.8/reference/global-options.mdx index 35b3b47e9..2ef141de0 100644 --- a/versioned_docs/version-2.8/reference/global-options.mdx +++ b/versioned_docs/version-2.8/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/check.mdx b/versioned_docs/version-2.8/reference/goals/check.mdx index f6cd6b602..a4710023e 100644 --- a/versioned_docs/version-2.8/reference/goals/check.mdx +++ b/versioned_docs/version-2.8/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/count-loc.mdx b/versioned_docs/version-2.8/reference/goals/count-loc.mdx index 2a304a47c..5d124a5db 100644 --- a/versioned_docs/version-2.8/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.8/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/coursier-resolve.mdx b/versioned_docs/version-2.8/reference/goals/coursier-resolve.mdx index cff592c35..d72ec89a1 100644 --- a/versioned_docs/version-2.8/reference/goals/coursier-resolve.mdx +++ b/versioned_docs/version-2.8/reference/goals/coursier-resolve.mdx @@ -1,5 +1,7 @@ --- title: coursier-resolve +description: | + Generate a lockfile by resolving JVM dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/dependees.mdx b/versioned_docs/version-2.8/reference/goals/dependees.mdx index ed77b3e96..6c4ac3df7 100644 --- a/versioned_docs/version-2.8/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.8/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/dependencies.mdx b/versioned_docs/version-2.8/reference/goals/dependencies.mdx index 26a750928..38aa73137 100644 --- a/versioned_docs/version-2.8/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.8/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/export-codegen.mdx b/versioned_docs/version-2.8/reference/goals/export-codegen.mdx index 88ab2b535..728c0678f 100644 --- a/versioned_docs/version-2.8/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.8/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/filedeps.mdx b/versioned_docs/version-2.8/reference/goals/filedeps.mdx index 54331cc62..157fd48e8 100644 --- a/versioned_docs/version-2.8/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.8/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/filter.mdx b/versioned_docs/version-2.8/reference/goals/filter.mdx index 034f8c0e3..fb25302e3 100644 --- a/versioned_docs/version-2.8/reference/goals/filter.mdx +++ b/versioned_docs/version-2.8/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/fmt.mdx b/versioned_docs/version-2.8/reference/goals/fmt.mdx index 5be691c37..f75125a92 100644 --- a/versioned_docs/version-2.8/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.8/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.8/reference/goals/generate-lockfiles.mdx index 83504d175..14b97edaa 100644 --- a/versioned_docs/version-2.8/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.8/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for Python third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/generate-user-lockfile.mdx b/versioned_docs/version-2.8/reference/goals/generate-user-lockfile.mdx index ca9d1f95a..3d169822d 100644 --- a/versioned_docs/version-2.8/reference/goals/generate-user-lockfile.mdx +++ b/versioned_docs/version-2.8/reference/goals/generate-user-lockfile.mdx @@ -1,5 +1,7 @@ --- title: generate-user-lockfile +description: | + Generate a lockfile for Python user requirements (experimental). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/java-dump-first-party-dep-map.mdx b/versioned_docs/version-2.8/reference/goals/java-dump-first-party-dep-map.mdx index 843b15229..77ae1b2ec 100644 --- a/versioned_docs/version-2.8/reference/goals/java-dump-first-party-dep-map.mdx +++ b/versioned_docs/version-2.8/reference/goals/java-dump-first-party-dep-map.mdx @@ -1,5 +1,7 @@ --- title: java-dump-first-party-dep-map +description: | + Dump dependency inference data for Java dep inference. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/lint.mdx b/versioned_docs/version-2.8/reference/goals/lint.mdx index c6137d62a..30409dc17 100644 --- a/versioned_docs/version-2.8/reference/goals/lint.mdx +++ b/versioned_docs/version-2.8/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/list.mdx b/versioned_docs/version-2.8/reference/goals/list.mdx index 25c0aaf82..82ad4cd72 100644 --- a/versioned_docs/version-2.8/reference/goals/list.mdx +++ b/versioned_docs/version-2.8/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/package.mdx b/versioned_docs/version-2.8/reference/goals/package.mdx index 80e42bfc9..62905b7b8 100644 --- a/versioned_docs/version-2.8/reference/goals/package.mdx +++ b/versioned_docs/version-2.8/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/peek.mdx b/versioned_docs/version-2.8/reference/goals/peek.mdx index 2f719856c..cddc95218 100644 --- a/versioned_docs/version-2.8/reference/goals/peek.mdx +++ b/versioned_docs/version-2.8/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/publish.mdx b/versioned_docs/version-2.8/reference/goals/publish.mdx index c28f12587..8f42eb813 100644 --- a/versioned_docs/version-2.8/reference/goals/publish.mdx +++ b/versioned_docs/version-2.8/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/py-constraints.mdx b/versioned_docs/version-2.8/reference/goals/py-constraints.mdx index 48728049e..b1292bc68 100644 --- a/versioned_docs/version-2.8/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.8/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/repl.mdx b/versioned_docs/version-2.8/reference/goals/repl.mdx index c2d756a60..e91a0ade9 100644 --- a/versioned_docs/version-2.8/reference/goals/repl.mdx +++ b/versioned_docs/version-2.8/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/roots.mdx b/versioned_docs/version-2.8/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.8/reference/goals/roots.mdx +++ b/versioned_docs/version-2.8/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/run.mdx b/versioned_docs/version-2.8/reference/goals/run.mdx index 90c72e119..fcadffce7 100644 --- a/versioned_docs/version-2.8/reference/goals/run.mdx +++ b/versioned_docs/version-2.8/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/tailor.mdx b/versioned_docs/version-2.8/reference/goals/tailor.mdx index 340968a27..e5cce775d 100644 --- a/versioned_docs/version-2.8/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.8/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/test.mdx b/versioned_docs/version-2.8/reference/goals/test.mdx index 6f78484f3..5792a21c7 100644 --- a/versioned_docs/version-2.8/reference/goals/test.mdx +++ b/versioned_docs/version-2.8/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/typecheck.mdx b/versioned_docs/version-2.8/reference/goals/typecheck.mdx index e68c0420a..4c7e49278 100644 --- a/versioned_docs/version-2.8/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.8/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/update-build-files.mdx b/versioned_docs/version-2.8/reference/goals/update-build-files.mdx index 2b3f6f9a1..0c2774baf 100644 --- a/versioned_docs/version-2.8/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.8/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/goals/validate.mdx b/versioned_docs/version-2.8/reference/goals/validate.mdx index 285de36dc..8d9012b39 100644 --- a/versioned_docs/version-2.8/reference/goals/validate.mdx +++ b/versioned_docs/version-2.8/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.8/reference/subsystems/anonymous-telemetry.mdx index f56a3921e..a7cf3837f 100644 --- a/versioned_docs/version-2.8/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.8/reference/subsystems/autoflake.mdx index 934573f66..31e78efd7 100644 --- a/versioned_docs/version-2.8/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/bandit.mdx b/versioned_docs/version-2.8/reference/subsystems/bandit.mdx index 4484766c9..fac54b62c 100644 --- a/versioned_docs/version-2.8/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/black.mdx b/versioned_docs/version-2.8/reference/subsystems/black.mdx index 7251637c4..867e640f7 100644 --- a/versioned_docs/version-2.8/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/changed.mdx b/versioned_docs/version-2.8/reference/subsystems/changed.mdx index 69912b37d..798f71bc9 100644 --- a/versioned_docs/version-2.8/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/cli.mdx b/versioned_docs/version-2.8/reference/subsystems/cli.mdx index 321d918c2..0adf0359c 100644 --- a/versioned_docs/version-2.8/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/coursier.mdx b/versioned_docs/version-2.8/reference/subsystems/coursier.mdx index dafcb508d..415179180 100644 --- a/versioned_docs/version-2.8/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.8/reference/subsystems/coverage-py.mdx index f5485b33b..1e8ea9e1b 100644 --- a/versioned_docs/version-2.8/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.8/reference/subsystems/docformatter.mdx index 3fafa642a..c3280c032 100644 --- a/versioned_docs/version-2.8/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/docker.mdx b/versioned_docs/version-2.8/reference/subsystems/docker.mdx index 2ea8e787b..e6b3f5919 100644 --- a/versioned_docs/version-2.8/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.8/reference/subsystems/dockerfile-parser.mdx index bfb7fee6a..3a18d25b7 100644 --- a/versioned_docs/version-2.8/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.8/reference/subsystems/download-pex-bin.mdx index 199f6d78b..407797be4 100644 --- a/versioned_docs/version-2.8/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/flake8.mdx b/versioned_docs/version-2.8/reference/subsystems/flake8.mdx index 1538e0a5c..457272b0a 100644 --- a/versioned_docs/version-2.8/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/go-test.mdx b/versioned_docs/version-2.8/reference/subsystems/go-test.mdx index 392183544..f1a85ef28 100644 --- a/versioned_docs/version-2.8/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.8/reference/subsystems/gofmt.mdx index be648b665..704bb59d1 100644 --- a/versioned_docs/version-2.8/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/golang.mdx b/versioned_docs/version-2.8/reference/subsystems/golang.mdx index 1f9e2a0e8..d22a7c33b 100644 --- a/versioned_docs/version-2.8/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.8/reference/subsystems/grpc-python-plugin.mdx index d25d17157..36505c6ac 100644 --- a/versioned_docs/version-2.8/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/ipython.mdx b/versioned_docs/version-2.8/reference/subsystems/ipython.mdx index 08bcc7413..ca826674c 100644 --- a/versioned_docs/version-2.8/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/isort.mdx b/versioned_docs/version-2.8/reference/subsystems/isort.mdx index 38c22ed1c..ebaadf10c 100644 --- a/versioned_docs/version-2.8/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.8/reference/subsystems/java-infer.mdx index 026b5774d..02a6bc83c 100644 --- a/versioned_docs/version-2.8/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/javac.mdx b/versioned_docs/version-2.8/reference/subsystems/javac.mdx index 7ffae6e9a..e793c714a 100644 --- a/versioned_docs/version-2.8/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/junit.mdx b/versioned_docs/version-2.8/reference/subsystems/junit.mdx index 3a33494af..9e391bdc2 100644 --- a/versioned_docs/version-2.8/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.8/reference/subsystems/lambdex.mdx index d1a9b4e9a..3714271c0 100644 --- a/versioned_docs/version-2.8/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.8/reference/subsystems/mypy-protobuf.mdx index 0af7f3dc9..4c4125464 100644 --- a/versioned_docs/version-2.8/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/mypy.mdx b/versioned_docs/version-2.8/reference/subsystems/mypy.mdx index 9955e2ac5..39d5afd8c 100644 --- a/versioned_docs/version-2.8/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.8/reference/subsystems/pex-binary-defaults.mdx index f439d5d21..f47a724a4 100644 --- a/versioned_docs/version-2.8/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/pex.mdx b/versioned_docs/version-2.8/reference/subsystems/pex.mdx index ddfc51ac0..20e6e6cd5 100644 --- a/versioned_docs/version-2.8/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/poetry.mdx b/versioned_docs/version-2.8/reference/subsystems/poetry.mdx index 913a3d6b8..ed9d872d1 100644 --- a/versioned_docs/version-2.8/reference/subsystems/poetry.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/poetry.mdx @@ -1,5 +1,7 @@ --- title: poetry +description: | + Used to generate lockfiles for third-party Python dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/protoc.mdx b/versioned_docs/version-2.8/reference/subsystems/protoc.mdx index 0a77bfc21..800c6baae 100644 --- a/versioned_docs/version-2.8/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/pylint.mdx b/versioned_docs/version-2.8/reference/subsystems/pylint.mdx index a823cb291..e0b1cca60 100644 --- a/versioned_docs/version-2.8/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/pytest.mdx b/versioned_docs/version-2.8/reference/subsystems/pytest.mdx index 77ad3e848..a09587f11 100644 --- a/versioned_docs/version-2.8/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.8/reference/subsystems/python-infer.mdx index 598165106..058fc1b81 100644 --- a/versioned_docs/version-2.8/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.8/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.8/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.8/reference/subsystems/python-protobuf.mdx index 34e420da5..cb13d62b7 100644 --- a/versioned_docs/version-2.8/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.8/reference/subsystems/python-repos.mdx index 9251d2c4e..bee1ff73f 100644 --- a/versioned_docs/version-2.8/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.8/reference/subsystems/python-setup.mdx index 069a0f15d..345366360 100644 --- a/versioned_docs/version-2.8/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + Options for Pants's Python support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/python.mdx b/versioned_docs/version-2.8/reference/subsystems/python.mdx index 688c95926..20552afe1 100644 --- a/versioned_docs/version-2.8/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.8/reference/subsystems/pyupgrade.mdx index 64865d346..4b4747da7 100644 --- a/versioned_docs/version-2.8/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/scc.mdx b/versioned_docs/version-2.8/reference/subsystems/scc.mdx index f091bdebc..46897fd9e 100644 --- a/versioned_docs/version-2.8/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.8/reference/subsystems/setup-py-generation.mdx index 8030ef03c..f4c68f727 100644 --- a/versioned_docs/version-2.8/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.8/reference/subsystems/setuptools.mdx index bd2a831ce..6f725bde0 100644 --- a/versioned_docs/version-2.8/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.8/reference/subsystems/shell-setup.mdx index b36794715..258adf20d 100644 --- a/versioned_docs/version-2.8/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.8/reference/subsystems/shellcheck.mdx index d3dce91f6..7a1d2a8a3 100644 --- a/versioned_docs/version-2.8/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.8/reference/subsystems/shfmt.mdx index 8ba794c1c..bba4a433b 100644 --- a/versioned_docs/version-2.8/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/source.mdx b/versioned_docs/version-2.8/reference/subsystems/source.mdx index da280cba6..eb1dc83cf 100644 --- a/versioned_docs/version-2.8/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.8/reference/subsystems/sourcefile-validation.mdx index 9ef2059de..2c5325dab 100644 --- a/versioned_docs/version-2.8/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/stats.mdx b/versioned_docs/version-2.8/reference/subsystems/stats.mdx index ff9788f19..4beb56117 100644 --- a/versioned_docs/version-2.8/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.8/reference/subsystems/subprocess-environment.mdx index 10f6580b4..17ba0a093 100644 --- a/versioned_docs/version-2.8/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/twine.mdx b/versioned_docs/version-2.8/reference/subsystems/twine.mdx index 1c751497a..cddac9d92 100644 --- a/versioned_docs/version-2.8/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPi and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/subsystems/yapf.mdx b/versioned_docs/version-2.8/reference/subsystems/yapf.mdx index 7f450cc9f..721f15537 100644 --- a/versioned_docs/version-2.8/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.8/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.8/reference/targets/archive.mdx b/versioned_docs/version-2.8/reference/targets/archive.mdx index c8d81aa55..a2a852065 100644 --- a/versioned_docs/version-2.8/reference/targets/archive.mdx +++ b/versioned_docs/version-2.8/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/coursier_lockfile.mdx b/versioned_docs/version-2.8/reference/targets/coursier_lockfile.mdx index a6cb46b71..92497e031 100644 --- a/versioned_docs/version-2.8/reference/targets/coursier_lockfile.mdx +++ b/versioned_docs/version-2.8/reference/targets/coursier_lockfile.mdx @@ -1,5 +1,7 @@ --- title: coursier_lockfile +description: | + A Coursier lockfile along with references to the artifacts to use for the lockfile. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.8/reference/targets/deploy_jar.mdx index 66053fe91..028f688b6 100644 --- a/versioned_docs/version-2.8/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.8/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file that contains the compiled source code along with its dependency class files, where the compiled class files from all dependency JARs, along with first-party class files, exist in a common directory structure. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/docker_image.mdx b/versioned_docs/version-2.8/reference/targets/docker_image.mdx index d56620d15..b555d4cc8 100644 --- a/versioned_docs/version-2.8/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.8/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/experimental_run_shell_command.mdx b/versioned_docs/version-2.8/reference/targets/experimental_run_shell_command.mdx index 6205540d1..66fc236b7 100644 --- a/versioned_docs/version-2.8/reference/targets/experimental_run_shell_command.mdx +++ b/versioned_docs/version-2.8/reference/targets/experimental_run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/experimental_shell_command.mdx b/versioned_docs/version-2.8/reference/targets/experimental_shell_command.mdx index d4791226b..b7de1dea6 100644 --- a/versioned_docs/version-2.8/reference/targets/experimental_shell_command.mdx +++ b/versioned_docs/version-2.8/reference/targets/experimental_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/file.mdx b/versioned_docs/version-2.8/reference/targets/file.mdx index e4b350a4f..8aed67159 100644 --- a/versioned_docs/version-2.8/reference/targets/file.mdx +++ b/versioned_docs/version-2.8/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/files.mdx b/versioned_docs/version-2.8/reference/targets/files.mdx index d85dcda2c..266ccfb5d 100644 --- a/versioned_docs/version-2.8/reference/targets/files.mdx +++ b/versioned_docs/version-2.8/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/go_binary.mdx b/versioned_docs/version-2.8/reference/targets/go_binary.mdx index e0c3f202f..99a47bd79 100644 --- a/versioned_docs/version-2.8/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.8/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/go_first_party_package.mdx b/versioned_docs/version-2.8/reference/targets/go_first_party_package.mdx index 846b7dcf3..91b0da815 100644 --- a/versioned_docs/version-2.8/reference/targets/go_first_party_package.mdx +++ b/versioned_docs/version-2.8/reference/targets/go_first_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_first_party_package +description: | + A Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/go_mod.mdx b/versioned_docs/version-2.8/reference/targets/go_mod.mdx index a26e42ee3..c238c476e 100644 --- a/versioned_docs/version-2.8/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.8/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.8/reference/targets/go_third_party_package.mdx index d2bf7c5ed..e23037e4b 100644 --- a/versioned_docs/version-2.8/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.8/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/java_source.mdx b/versioned_docs/version-2.8/reference/targets/java_source.mdx index ab9cb1626..438fa09dc 100644 --- a/versioned_docs/version-2.8/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.8/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/java_sources.mdx b/versioned_docs/version-2.8/reference/targets/java_sources.mdx index c6499029e..9d445bb43 100644 --- a/versioned_docs/version-2.8/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.8/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/junit_test.mdx b/versioned_docs/version-2.8/reference/targets/junit_test.mdx index b57ce5f5c..ec6a82a66 100644 --- a/versioned_docs/version-2.8/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.8/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/junit_tests.mdx b/versioned_docs/version-2.8/reference/targets/junit_tests.mdx index 1b2e7da31..08910966e 100644 --- a/versioned_docs/version-2.8/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.8/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.8/reference/targets/jvm_artifact.mdx index bc51b7896..27f9bb258 100644 --- a/versioned_docs/version-2.8/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.8/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + Represents a third-party JVM artifact as identified by its Maven-compatible coordinate, that is, its `group`, `artifact`, and `version` components. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/pex_binary.mdx b/versioned_docs/version-2.8/reference/targets/pex_binary.mdx index 489e5149f..df373bbd3 100644 --- a/versioned_docs/version-2.8/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.8/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.8/reference/targets/protobuf_source.mdx index 38269682e..4ea0441eb 100644 --- a/versioned_docs/version-2.8/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.8/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.8/reference/targets/protobuf_sources.mdx index 829e5e0a9..1f3e36b1c 100644 --- a/versioned_docs/version-2.8/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.8/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.8/reference/targets/python_awslambda.mdx index 4848cafec..b22f74ae3 100644 --- a/versioned_docs/version-2.8/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.8/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/python_distribution.mdx b/versioned_docs/version-2.8/reference/targets/python_distribution.mdx index ec91606ba..5e186ba6f 100644 --- a/versioned_docs/version-2.8/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.8/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/python_requirement.mdx b/versioned_docs/version-2.8/reference/targets/python_requirement.mdx index 006df486c..9f3418d59 100644 --- a/versioned_docs/version-2.8/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.8/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/python_source.mdx b/versioned_docs/version-2.8/reference/targets/python_source.mdx index d81d3edfe..9fce118be 100644 --- a/versioned_docs/version-2.8/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.8/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/python_sources.mdx b/versioned_docs/version-2.8/reference/targets/python_sources.mdx index 9a9cd9723..670799b25 100644 --- a/versioned_docs/version-2.8/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.8/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/python_test.mdx b/versioned_docs/version-2.8/reference/targets/python_test.mdx index e0b428d2f..7d4597278 100644 --- a/versioned_docs/version-2.8/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.8/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.8/reference/targets/python_test_utils.mdx index 906a84858..978660639 100644 --- a/versioned_docs/version-2.8/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.8/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/python_tests.mdx b/versioned_docs/version-2.8/reference/targets/python_tests.mdx index 25f68d43a..084c705f0 100644 --- a/versioned_docs/version-2.8/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.8/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/relocated_files.mdx b/versioned_docs/version-2.8/reference/targets/relocated_files.mdx index 44a0c8ff2..76471cbbb 100644 --- a/versioned_docs/version-2.8/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.8/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/resource.mdx b/versioned_docs/version-2.8/reference/targets/resource.mdx index 22591a65e..912218180 100644 --- a/versioned_docs/version-2.8/reference/targets/resource.mdx +++ b/versioned_docs/version-2.8/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/resources.mdx b/versioned_docs/version-2.8/reference/targets/resources.mdx index e7c686a2f..3906be0ee 100644 --- a/versioned_docs/version-2.8/reference/targets/resources.mdx +++ b/versioned_docs/version-2.8/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/shell_source.mdx b/versioned_docs/version-2.8/reference/targets/shell_source.mdx index 716164f65..95ed86bbb 100644 --- a/versioned_docs/version-2.8/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.8/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/shell_sources.mdx b/versioned_docs/version-2.8/reference/targets/shell_sources.mdx index 53aca825c..b11564e32 100644 --- a/versioned_docs/version-2.8/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.8/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.8/reference/targets/shunit2_test.mdx index 88380ee6b..bf6d440dd 100644 --- a/versioned_docs/version-2.8/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.8/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.8/reference/targets/shunit2_tests.mdx index 2fc5dba40..851f854d6 100644 --- a/versioned_docs/version-2.8/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.8/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.8/reference/targets/target.mdx b/versioned_docs/version-2.8/reference/targets/target.mdx index 00c179219..65f862e7d 100644 --- a/versioned_docs/version-2.8/reference/targets/target.mdx +++ b/versioned_docs/version-2.8/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/global-options.mdx b/versioned_docs/version-2.9/reference/global-options.mdx index f7f0e27e9..593575e48 100644 --- a/versioned_docs/version-2.9/reference/global-options.mdx +++ b/versioned_docs/version-2.9/reference/global-options.mdx @@ -1,5 +1,7 @@ --- title: Global options +description: | + Options to control the overall behavior of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/check.mdx b/versioned_docs/version-2.9/reference/goals/check.mdx index f6cd6b602..a4710023e 100644 --- a/versioned_docs/version-2.9/reference/goals/check.mdx +++ b/versioned_docs/version-2.9/reference/goals/check.mdx @@ -1,5 +1,7 @@ --- title: check +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/count-loc.mdx b/versioned_docs/version-2.9/reference/goals/count-loc.mdx index 93ad1be0b..12fc7f0e8 100644 --- a/versioned_docs/version-2.9/reference/goals/count-loc.mdx +++ b/versioned_docs/version-2.9/reference/goals/count-loc.mdx @@ -1,5 +1,7 @@ --- title: count-loc +description: | + Count lines of code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/coursier-resolve.mdx b/versioned_docs/version-2.9/reference/goals/coursier-resolve.mdx index 5ce7ca5b4..afa7dc8c1 100644 --- a/versioned_docs/version-2.9/reference/goals/coursier-resolve.mdx +++ b/versioned_docs/version-2.9/reference/goals/coursier-resolve.mdx @@ -1,5 +1,7 @@ --- title: coursier-resolve +description: | + Generate a lockfile by resolving JVM dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/dependees.mdx b/versioned_docs/version-2.9/reference/goals/dependees.mdx index 8e5ce9f15..9dfff4ca2 100644 --- a/versioned_docs/version-2.9/reference/goals/dependees.mdx +++ b/versioned_docs/version-2.9/reference/goals/dependees.mdx @@ -1,5 +1,7 @@ --- title: dependees +description: | + List all targets that depend on any of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/dependencies.mdx b/versioned_docs/version-2.9/reference/goals/dependencies.mdx index 9b334f6c6..f15bbac72 100644 --- a/versioned_docs/version-2.9/reference/goals/dependencies.mdx +++ b/versioned_docs/version-2.9/reference/goals/dependencies.mdx @@ -1,5 +1,7 @@ --- title: dependencies +description: | + List the dependencies of the input files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/export-codegen.mdx b/versioned_docs/version-2.9/reference/goals/export-codegen.mdx index 88ab2b535..728c0678f 100644 --- a/versioned_docs/version-2.9/reference/goals/export-codegen.mdx +++ b/versioned_docs/version-2.9/reference/goals/export-codegen.mdx @@ -1,5 +1,7 @@ --- title: export-codegen +description: | + Write generated files to `dist/codegen` for use outside of Pants. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/export.mdx b/versioned_docs/version-2.9/reference/goals/export.mdx index c68077a51..9def8594f 100644 --- a/versioned_docs/version-2.9/reference/goals/export.mdx +++ b/versioned_docs/version-2.9/reference/goals/export.mdx @@ -1,5 +1,7 @@ --- title: export +description: | + Export Pants data for use in other tools, such as IDEs. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/filedeps.mdx b/versioned_docs/version-2.9/reference/goals/filedeps.mdx index 54331cc62..157fd48e8 100644 --- a/versioned_docs/version-2.9/reference/goals/filedeps.mdx +++ b/versioned_docs/version-2.9/reference/goals/filedeps.mdx @@ -1,5 +1,7 @@ --- title: filedeps +description: | + List all source and BUILD files a target depends on. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/filter.mdx b/versioned_docs/version-2.9/reference/goals/filter.mdx index 034f8c0e3..fb25302e3 100644 --- a/versioned_docs/version-2.9/reference/goals/filter.mdx +++ b/versioned_docs/version-2.9/reference/goals/filter.mdx @@ -1,5 +1,7 @@ --- title: filter +description: | + Filter the input targets based on various criteria. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/fmt.mdx b/versioned_docs/version-2.9/reference/goals/fmt.mdx index 5be691c37..f75125a92 100644 --- a/versioned_docs/version-2.9/reference/goals/fmt.mdx +++ b/versioned_docs/version-2.9/reference/goals/fmt.mdx @@ -1,5 +1,7 @@ --- title: fmt +description: | + Autoformat source code. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/generate-lockfiles.mdx b/versioned_docs/version-2.9/reference/goals/generate-lockfiles.mdx index 4c1215f52..3fe2dc215 100644 --- a/versioned_docs/version-2.9/reference/goals/generate-lockfiles.mdx +++ b/versioned_docs/version-2.9/reference/goals/generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: generate-lockfiles +description: | + Generate lockfiles for Python third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/generate-user-lockfile.mdx b/versioned_docs/version-2.9/reference/goals/generate-user-lockfile.mdx index 65d29f6dc..f7116acb8 100644 --- a/versioned_docs/version-2.9/reference/goals/generate-user-lockfile.mdx +++ b/versioned_docs/version-2.9/reference/goals/generate-user-lockfile.mdx @@ -1,5 +1,7 @@ --- title: generate-user-lockfile +description: | + Generate a lockfile for Python user requirements (experimental). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/jvm-generate-lockfiles.mdx b/versioned_docs/version-2.9/reference/goals/jvm-generate-lockfiles.mdx index e9011e6d5..9acc1ea94 100644 --- a/versioned_docs/version-2.9/reference/goals/jvm-generate-lockfiles.mdx +++ b/versioned_docs/version-2.9/reference/goals/jvm-generate-lockfiles.mdx @@ -1,5 +1,7 @@ --- title: jvm-generate-lockfiles +description: | + Generate lockfiles for JVM tools third-party dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/lint.mdx b/versioned_docs/version-2.9/reference/goals/lint.mdx index c6137d62a..30409dc17 100644 --- a/versioned_docs/version-2.9/reference/goals/lint.mdx +++ b/versioned_docs/version-2.9/reference/goals/lint.mdx @@ -1,5 +1,7 @@ --- title: lint +description: | + Run all linters and/or formatters in check mode. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/list.mdx b/versioned_docs/version-2.9/reference/goals/list.mdx index e9af87b95..d23e67fb1 100644 --- a/versioned_docs/version-2.9/reference/goals/list.mdx +++ b/versioned_docs/version-2.9/reference/goals/list.mdx @@ -1,5 +1,7 @@ --- title: list +description: | + Lists all targets matching the file or target arguments. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/package.mdx b/versioned_docs/version-2.9/reference/goals/package.mdx index 80e42bfc9..62905b7b8 100644 --- a/versioned_docs/version-2.9/reference/goals/package.mdx +++ b/versioned_docs/version-2.9/reference/goals/package.mdx @@ -1,5 +1,7 @@ --- title: package +description: | + Create a distributable package. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/paths.mdx b/versioned_docs/version-2.9/reference/goals/paths.mdx index 6ec281610..1ed46db10 100644 --- a/versioned_docs/version-2.9/reference/goals/paths.mdx +++ b/versioned_docs/version-2.9/reference/goals/paths.mdx @@ -1,5 +1,7 @@ --- title: paths +description: | + List the paths between two addresses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/peek.mdx b/versioned_docs/version-2.9/reference/goals/peek.mdx index 94e2bdb30..7b9334852 100644 --- a/versioned_docs/version-2.9/reference/goals/peek.mdx +++ b/versioned_docs/version-2.9/reference/goals/peek.mdx @@ -1,5 +1,7 @@ --- title: peek +description: | + Display BUILD target info --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/publish.mdx b/versioned_docs/version-2.9/reference/goals/publish.mdx index c28f12587..8f42eb813 100644 --- a/versioned_docs/version-2.9/reference/goals/publish.mdx +++ b/versioned_docs/version-2.9/reference/goals/publish.mdx @@ -1,5 +1,7 @@ --- title: publish +description: | + Publish deliverables (assets, distributions, images, etc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/py-constraints.mdx b/versioned_docs/version-2.9/reference/goals/py-constraints.mdx index 48728049e..b1292bc68 100644 --- a/versioned_docs/version-2.9/reference/goals/py-constraints.mdx +++ b/versioned_docs/version-2.9/reference/goals/py-constraints.mdx @@ -1,5 +1,7 @@ --- title: py-constraints +description: | + Determine what Python interpreter constraints are used by files/targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/repl.mdx b/versioned_docs/version-2.9/reference/goals/repl.mdx index c2d756a60..e91a0ade9 100644 --- a/versioned_docs/version-2.9/reference/goals/repl.mdx +++ b/versioned_docs/version-2.9/reference/goals/repl.mdx @@ -1,5 +1,7 @@ --- title: repl +description: | + Open a REPL with the specified code loadable. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/roots.mdx b/versioned_docs/version-2.9/reference/goals/roots.mdx index e8ed5261c..d94b2588f 100644 --- a/versioned_docs/version-2.9/reference/goals/roots.mdx +++ b/versioned_docs/version-2.9/reference/goals/roots.mdx @@ -1,5 +1,7 @@ --- title: roots +description: | + List the repo's registered source roots. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/run.mdx b/versioned_docs/version-2.9/reference/goals/run.mdx index f7cfbf348..a22718459 100644 --- a/versioned_docs/version-2.9/reference/goals/run.mdx +++ b/versioned_docs/version-2.9/reference/goals/run.mdx @@ -1,5 +1,7 @@ --- title: run +description: | + Runs a binary target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/tailor.mdx b/versioned_docs/version-2.9/reference/goals/tailor.mdx index 791a7a96c..83478155c 100644 --- a/versioned_docs/version-2.9/reference/goals/tailor.mdx +++ b/versioned_docs/version-2.9/reference/goals/tailor.mdx @@ -1,5 +1,7 @@ --- title: tailor +description: | + Auto-generate BUILD file targets for new source files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/test.mdx b/versioned_docs/version-2.9/reference/goals/test.mdx index 6f78484f3..5792a21c7 100644 --- a/versioned_docs/version-2.9/reference/goals/test.mdx +++ b/versioned_docs/version-2.9/reference/goals/test.mdx @@ -1,5 +1,7 @@ --- title: test +description: | + Run tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/typecheck.mdx b/versioned_docs/version-2.9/reference/goals/typecheck.mdx index e68c0420a..4c7e49278 100644 --- a/versioned_docs/version-2.9/reference/goals/typecheck.mdx +++ b/versioned_docs/version-2.9/reference/goals/typecheck.mdx @@ -1,5 +1,7 @@ --- title: typecheck +description: | + Run type checking or the lightest variant of compilation available for a language. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/update-build-files.mdx b/versioned_docs/version-2.9/reference/goals/update-build-files.mdx index b58d70af9..799ab3503 100644 --- a/versioned_docs/version-2.9/reference/goals/update-build-files.mdx +++ b/versioned_docs/version-2.9/reference/goals/update-build-files.mdx @@ -1,5 +1,7 @@ --- title: update-build-files +description: | + Format and fix safe deprecations in BUILD files. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/goals/validate.mdx b/versioned_docs/version-2.9/reference/goals/validate.mdx index 285de36dc..8d9012b39 100644 --- a/versioned_docs/version-2.9/reference/goals/validate.mdx +++ b/versioned_docs/version-2.9/reference/goals/validate.mdx @@ -1,5 +1,7 @@ --- title: validate +description: | + Validate sources against regexes. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/anonymous-telemetry.mdx b/versioned_docs/version-2.9/reference/subsystems/anonymous-telemetry.mdx index c6fec9ec5..34318b872 100644 --- a/versioned_docs/version-2.9/reference/subsystems/anonymous-telemetry.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/anonymous-telemetry.mdx @@ -1,5 +1,7 @@ --- title: anonymous-telemetry +description: | + Options related to sending anonymous stats to the Pants project, to aid development. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/autoflake.mdx b/versioned_docs/version-2.9/reference/subsystems/autoflake.mdx index 3fc114352..9c88f9461 100644 --- a/versioned_docs/version-2.9/reference/subsystems/autoflake.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/autoflake.mdx @@ -1,5 +1,7 @@ --- title: autoflake +description: | + The Autoflake Python code formatter (https://github.com/myint/autoflake). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/bandit.mdx b/versioned_docs/version-2.9/reference/subsystems/bandit.mdx index 661d4e570..c9459f66d 100644 --- a/versioned_docs/version-2.9/reference/subsystems/bandit.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/bandit.mdx @@ -1,5 +1,7 @@ --- title: bandit +description: | + A tool for finding security issues in Python code (https://bandit.readthedocs.io). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/black.mdx b/versioned_docs/version-2.9/reference/subsystems/black.mdx index 7af7acbd0..5109f6de6 100644 --- a/versioned_docs/version-2.9/reference/subsystems/black.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/black.mdx @@ -1,5 +1,7 @@ --- title: black +description: | + The Black Python code formatter (https://black.readthedocs.io/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/changed.mdx b/versioned_docs/version-2.9/reference/subsystems/changed.mdx index 20f7d09d7..5e1239588 100644 --- a/versioned_docs/version-2.9/reference/subsystems/changed.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/changed.mdx @@ -1,5 +1,7 @@ --- title: changed +description: | + Tell Pants to detect what files and targets have changed from Git. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/cli.mdx b/versioned_docs/version-2.9/reference/subsystems/cli.mdx index 321d918c2..0adf0359c 100644 --- a/versioned_docs/version-2.9/reference/subsystems/cli.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/cli.mdx @@ -1,5 +1,7 @@ --- title: cli +description: | + Options for configuring CLI behavior, such as command line aliases. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/coursier.mdx b/versioned_docs/version-2.9/reference/subsystems/coursier.mdx index c4b7cd340..8d13bb222 100644 --- a/versioned_docs/version-2.9/reference/subsystems/coursier.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/coursier.mdx @@ -1,5 +1,7 @@ --- title: coursier +description: | + A dependency resolver for the Maven ecosystem. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/coverage-py.mdx b/versioned_docs/version-2.9/reference/subsystems/coverage-py.mdx index 73f7d52ca..89d4546c9 100644 --- a/versioned_docs/version-2.9/reference/subsystems/coverage-py.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/coverage-py.mdx @@ -1,5 +1,7 @@ --- title: coverage-py +description: | + Configuration for Python test coverage measurement. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/docformatter.mdx b/versioned_docs/version-2.9/reference/subsystems/docformatter.mdx index fba66807d..811571ec5 100644 --- a/versioned_docs/version-2.9/reference/subsystems/docformatter.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/docformatter.mdx @@ -1,5 +1,7 @@ --- title: docformatter +description: | + The Python docformatter tool (https://github.com/myint/docformatter). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/docker.mdx b/versioned_docs/version-2.9/reference/subsystems/docker.mdx index d79817b39..4fda76564 100644 --- a/versioned_docs/version-2.9/reference/subsystems/docker.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/docker.mdx @@ -1,5 +1,7 @@ --- title: docker +description: | + Options for interacting with Docker. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/dockerfile-parser.mdx b/versioned_docs/version-2.9/reference/subsystems/dockerfile-parser.mdx index 93185675d..7e194502a 100644 --- a/versioned_docs/version-2.9/reference/subsystems/dockerfile-parser.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/dockerfile-parser.mdx @@ -1,5 +1,7 @@ --- title: dockerfile-parser +description: | + Used to parse Dockerfile build specs to infer their dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/download-pex-bin.mdx b/versioned_docs/version-2.9/reference/subsystems/download-pex-bin.mdx index 372b7a53a..96aec9b82 100644 --- a/versioned_docs/version-2.9/reference/subsystems/download-pex-bin.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/download-pex-bin.mdx @@ -1,5 +1,7 @@ --- title: download-pex-bin +description: | + The PEX (Python EXecutable) tool (https://github.com/pantsbuild/pex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/flake8.mdx b/versioned_docs/version-2.9/reference/subsystems/flake8.mdx index 1e61a3ed9..e1774f1fa 100644 --- a/versioned_docs/version-2.9/reference/subsystems/flake8.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/flake8.mdx @@ -1,5 +1,7 @@ --- title: flake8 +description: | + The Flake8 Python linter (https://flake8.pycqa.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/go-test.mdx b/versioned_docs/version-2.9/reference/subsystems/go-test.mdx index 956c922d1..91c688758 100644 --- a/versioned_docs/version-2.9/reference/subsystems/go-test.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/go-test.mdx @@ -1,5 +1,7 @@ --- title: go-test +description: | + Options for Go tests. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/gofmt.mdx b/versioned_docs/version-2.9/reference/subsystems/gofmt.mdx index be648b665..704bb59d1 100644 --- a/versioned_docs/version-2.9/reference/subsystems/gofmt.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/gofmt.mdx @@ -1,5 +1,7 @@ --- title: gofmt +description: | + Gofmt-specific options. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/golang.mdx b/versioned_docs/version-2.9/reference/subsystems/golang.mdx index 273fb65c9..7b85953d1 100644 --- a/versioned_docs/version-2.9/reference/subsystems/golang.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/golang.mdx @@ -1,5 +1,7 @@ --- title: golang +description: | + Options for Golang support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.9/reference/subsystems/google-java-format.mdx index 75b5df71d..110906e29 100644 --- a/versioned_docs/version-2.9/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/google-java-format.mdx @@ -1,5 +1,7 @@ --- title: google-java-format +description: | + Google Java Format (https://github.com/google/google-java-format) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/grpc-python-plugin.mdx b/versioned_docs/version-2.9/reference/subsystems/grpc-python-plugin.mdx index 6980fdcdd..bda71fd27 100644 --- a/versioned_docs/version-2.9/reference/subsystems/grpc-python-plugin.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/grpc-python-plugin.mdx @@ -1,5 +1,7 @@ --- title: grpc-python-plugin +description: | + The gRPC Protobuf plugin for Python. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/hadolint.mdx b/versioned_docs/version-2.9/reference/subsystems/hadolint.mdx index 28dc9418d..ba85bac5b 100644 --- a/versioned_docs/version-2.9/reference/subsystems/hadolint.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/hadolint.mdx @@ -1,5 +1,7 @@ --- title: hadolint +description: | + A linter for Dockerfiles. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/ipython.mdx b/versioned_docs/version-2.9/reference/subsystems/ipython.mdx index 6b8eb50ce..2e1880e3c 100644 --- a/versioned_docs/version-2.9/reference/subsystems/ipython.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/ipython.mdx @@ -1,5 +1,7 @@ --- title: ipython +description: | + The IPython enhanced REPL (https://ipython.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/isort.mdx b/versioned_docs/version-2.9/reference/subsystems/isort.mdx index a28b5d859..c0aa86eb9 100644 --- a/versioned_docs/version-2.9/reference/subsystems/isort.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/isort.mdx @@ -1,5 +1,7 @@ --- title: isort +description: | + The Python import sorter tool (https://pycqa.github.io/isort/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/java-infer.mdx b/versioned_docs/version-2.9/reference/subsystems/java-infer.mdx index b0de1b26e..d0ac817b0 100644 --- a/versioned_docs/version-2.9/reference/subsystems/java-infer.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/java-infer.mdx @@ -1,5 +1,7 @@ --- title: java-infer +description: | + Options controlling which dependencies will be inferred for Java targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/javac.mdx b/versioned_docs/version-2.9/reference/subsystems/javac.mdx index 6e99afd13..0953af5dc 100644 --- a/versioned_docs/version-2.9/reference/subsystems/javac.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/javac.mdx @@ -1,5 +1,7 @@ --- title: javac +description: | + The javac Java source compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/junit.mdx b/versioned_docs/version-2.9/reference/subsystems/junit.mdx index b09663058..3ee777004 100644 --- a/versioned_docs/version-2.9/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/junit.mdx @@ -1,5 +1,7 @@ --- title: junit +description: | + The JUnit test framework (https://junit.org) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/jvm.mdx b/versioned_docs/version-2.9/reference/subsystems/jvm.mdx index 5ddd32ff3..56c936d16 100644 --- a/versioned_docs/version-2.9/reference/subsystems/jvm.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/jvm.mdx @@ -1,5 +1,7 @@ --- title: jvm +description: | + Options for general JVM functionality. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/lambdex.mdx b/versioned_docs/version-2.9/reference/subsystems/lambdex.mdx index f8412b139..e056f162b 100644 --- a/versioned_docs/version-2.9/reference/subsystems/lambdex.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/lambdex.mdx @@ -1,5 +1,7 @@ --- title: lambdex +description: | + A tool for turning .pex files into Function-as-a-Service artifacts (https://github.com/pantsbuild/lambdex). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/mypy-protobuf.mdx b/versioned_docs/version-2.9/reference/subsystems/mypy-protobuf.mdx index a9d912f30..e6544a426 100644 --- a/versioned_docs/version-2.9/reference/subsystems/mypy-protobuf.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/mypy-protobuf.mdx @@ -1,5 +1,7 @@ --- title: mypy-protobuf +description: | + Configuration of the mypy-protobuf type stub generation plugin. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/mypy.mdx b/versioned_docs/version-2.9/reference/subsystems/mypy.mdx index d3979a729..f21c41b18 100644 --- a/versioned_docs/version-2.9/reference/subsystems/mypy.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/mypy.mdx @@ -1,5 +1,7 @@ --- title: mypy +description: | + The MyPy Python type checker (http://mypy-lang.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/pex-binary-defaults.mdx b/versioned_docs/version-2.9/reference/subsystems/pex-binary-defaults.mdx index 84eb9b675..7c215a140 100644 --- a/versioned_docs/version-2.9/reference/subsystems/pex-binary-defaults.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/pex-binary-defaults.mdx @@ -1,5 +1,7 @@ --- title: pex-binary-defaults +description: | + Default settings for creating PEX executables. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/pex.mdx b/versioned_docs/version-2.9/reference/subsystems/pex.mdx index 3ad22c223..35c68d445 100644 --- a/versioned_docs/version-2.9/reference/subsystems/pex.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/pex.mdx @@ -1,5 +1,7 @@ --- title: pex +description: | + How Pants uses Pex to run Python subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/poetry.mdx b/versioned_docs/version-2.9/reference/subsystems/poetry.mdx index 913a3d6b8..ed9d872d1 100644 --- a/versioned_docs/version-2.9/reference/subsystems/poetry.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/poetry.mdx @@ -1,5 +1,7 @@ --- title: poetry +description: | + Used to generate lockfiles for third-party Python dependencies. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/protoc.mdx b/versioned_docs/version-2.9/reference/subsystems/protoc.mdx index 54a1e6851..2f3631594 100644 --- a/versioned_docs/version-2.9/reference/subsystems/protoc.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/protoc.mdx @@ -1,5 +1,7 @@ --- title: protoc +description: | + The protocol buffer compiler (https://developers.google.com/protocol-buffers). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/pylint.mdx b/versioned_docs/version-2.9/reference/subsystems/pylint.mdx index 5ce47275a..6572d3609 100644 --- a/versioned_docs/version-2.9/reference/subsystems/pylint.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/pylint.mdx @@ -1,5 +1,7 @@ --- title: pylint +description: | + The Pylint linter for Python code (https://www.pylint.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/pytest.mdx b/versioned_docs/version-2.9/reference/subsystems/pytest.mdx index 2575b95e6..1d717a486 100644 --- a/versioned_docs/version-2.9/reference/subsystems/pytest.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/pytest.mdx @@ -1,5 +1,7 @@ --- title: pytest +description: | + The pytest Python test framework (https://docs.pytest.org/). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/python-bootstrap.mdx b/versioned_docs/version-2.9/reference/subsystems/python-bootstrap.mdx index 977782a07..2e52bba6d 100644 --- a/versioned_docs/version-2.9/reference/subsystems/python-bootstrap.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/python-bootstrap.mdx @@ -1,5 +1,7 @@ --- title: python-bootstrap +description: | + Options used to locate Python interpreters used by all Pants backends. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/python-infer.mdx b/versioned_docs/version-2.9/reference/subsystems/python-infer.mdx index 345e66a40..4bdf9cef2 100644 --- a/versioned_docs/version-2.9/reference/subsystems/python-infer.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/python-infer.mdx @@ -1,5 +1,7 @@ --- title: python-infer +description: | + Options controlling which dependencies will be inferred for Python targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/python-native-code.mdx b/versioned_docs/version-2.9/reference/subsystems/python-native-code.mdx index ecff69e3a..7a0746aac 100644 --- a/versioned_docs/version-2.9/reference/subsystems/python-native-code.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/python-native-code.mdx @@ -1,5 +1,7 @@ --- title: python-native-code +description: | + Options for building native code using Python, e.g. when resolving distributions. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/python-protobuf.mdx b/versioned_docs/version-2.9/reference/subsystems/python-protobuf.mdx index b690d79d6..74b4c70da 100644 --- a/versioned_docs/version-2.9/reference/subsystems/python-protobuf.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/python-protobuf.mdx @@ -1,5 +1,7 @@ --- title: python-protobuf +description: | + Options related to the Protobuf Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/python-repos.mdx b/versioned_docs/version-2.9/reference/subsystems/python-repos.mdx index 9251d2c4e..bee1ff73f 100644 --- a/versioned_docs/version-2.9/reference/subsystems/python-repos.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/python-repos.mdx @@ -1,5 +1,7 @@ --- title: python-repos +description: | + External Python code repositories, such as PyPI. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/python-setup.mdx b/versioned_docs/version-2.9/reference/subsystems/python-setup.mdx index c41bd81ab..f16059391 100644 --- a/versioned_docs/version-2.9/reference/subsystems/python-setup.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/python-setup.mdx @@ -1,5 +1,7 @@ --- title: python-setup +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/python.mdx b/versioned_docs/version-2.9/reference/subsystems/python.mdx index cc856425c..685d9a063 100644 --- a/versioned_docs/version-2.9/reference/subsystems/python.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/python.mdx @@ -1,5 +1,7 @@ --- title: python +description: | + Options for Pants's Python backend. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/pyupgrade.mdx b/versioned_docs/version-2.9/reference/subsystems/pyupgrade.mdx index 5fdfcb632..236b6c66b 100644 --- a/versioned_docs/version-2.9/reference/subsystems/pyupgrade.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/pyupgrade.mdx @@ -1,5 +1,7 @@ --- title: pyupgrade +description: | + Upgrade syntax for newer versions of the language (https://github.com/asottile/pyupgrade). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/scala-infer.mdx b/versioned_docs/version-2.9/reference/subsystems/scala-infer.mdx index c2946ae2b..bffe93d34 100644 --- a/versioned_docs/version-2.9/reference/subsystems/scala-infer.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/scala-infer.mdx @@ -1,5 +1,7 @@ --- title: scala-infer +description: | + Options controlling which dependencies will be inferred for Scala targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/scala.mdx b/versioned_docs/version-2.9/reference/subsystems/scala.mdx index c3e845b43..ee5f455ee 100644 --- a/versioned_docs/version-2.9/reference/subsystems/scala.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/scala.mdx @@ -1,5 +1,7 @@ --- title: scala +description: | + Scala programming language --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/scalac.mdx b/versioned_docs/version-2.9/reference/subsystems/scalac.mdx index fe8c42fc3..a28fa6817 100644 --- a/versioned_docs/version-2.9/reference/subsystems/scalac.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/scalac.mdx @@ -1,5 +1,7 @@ --- title: scalac +description: | + The Scala compiler. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.9/reference/subsystems/scalafmt.mdx index e8105ba51..5f2d29bd4 100644 --- a/versioned_docs/version-2.9/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/scalafmt.mdx @@ -1,5 +1,7 @@ --- title: scalafmt +description: | + scalafmt (https://scalameta.org/scalafmt/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.9/reference/subsystems/scalatest.mdx index c29b6e2ba..1f519f64e 100644 --- a/versioned_docs/version-2.9/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/scalatest.mdx @@ -1,5 +1,7 @@ --- title: scalatest +description: | + The Scalatest test framework (https://www.scalatest.org/) --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/scc.mdx b/versioned_docs/version-2.9/reference/subsystems/scc.mdx index f0c9f3b72..14b36e734 100644 --- a/versioned_docs/version-2.9/reference/subsystems/scc.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/scc.mdx @@ -1,5 +1,7 @@ --- title: scc +description: | + The Succinct Code Counter, aka `scc` (https://github.com/boyter/scc). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/setup-py-generation.mdx b/versioned_docs/version-2.9/reference/subsystems/setup-py-generation.mdx index 8030ef03c..f4c68f727 100644 --- a/versioned_docs/version-2.9/reference/subsystems/setup-py-generation.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/setup-py-generation.mdx @@ -1,5 +1,7 @@ --- title: setup-py-generation +description: | + Options to control how setup.py is generated from a `python_distribution` target. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/setuptools.mdx b/versioned_docs/version-2.9/reference/subsystems/setuptools.mdx index fc5fe0dd5..c2047a787 100644 --- a/versioned_docs/version-2.9/reference/subsystems/setuptools.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/setuptools.mdx @@ -1,5 +1,7 @@ --- title: setuptools +description: | + Python setuptools, used to package `python_distribution` targets. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/shell-setup.mdx b/versioned_docs/version-2.9/reference/subsystems/shell-setup.mdx index b36794715..258adf20d 100644 --- a/versioned_docs/version-2.9/reference/subsystems/shell-setup.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/shell-setup.mdx @@ -1,5 +1,7 @@ --- title: shell-setup +description: | + Options for Pants's Shell support. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/shellcheck.mdx b/versioned_docs/version-2.9/reference/subsystems/shellcheck.mdx index b219d9571..b50ea7864 100644 --- a/versioned_docs/version-2.9/reference/subsystems/shellcheck.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/shellcheck.mdx @@ -1,5 +1,7 @@ --- title: shellcheck +description: | + A linter for shell scripts. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/shfmt.mdx b/versioned_docs/version-2.9/reference/subsystems/shfmt.mdx index 65a785fe7..a06beee1f 100644 --- a/versioned_docs/version-2.9/reference/subsystems/shfmt.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/shfmt.mdx @@ -1,5 +1,7 @@ --- title: shfmt +description: | + An autoformatter for shell scripts (https://github.com/mvdan/sh). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/source.mdx b/versioned_docs/version-2.9/reference/subsystems/source.mdx index b56ae7320..2e9c1100f 100644 --- a/versioned_docs/version-2.9/reference/subsystems/source.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/source.mdx @@ -1,5 +1,7 @@ --- title: source +description: | + Configuration for roots of source trees. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/sourcefile-validation.mdx b/versioned_docs/version-2.9/reference/subsystems/sourcefile-validation.mdx index 9ef2059de..2c5325dab 100644 --- a/versioned_docs/version-2.9/reference/subsystems/sourcefile-validation.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/sourcefile-validation.mdx @@ -1,5 +1,7 @@ --- title: sourcefile-validation +description: | + Configuration for source file validation. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/stats.mdx b/versioned_docs/version-2.9/reference/subsystems/stats.mdx index ff9788f19..4beb56117 100644 --- a/versioned_docs/version-2.9/reference/subsystems/stats.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/stats.mdx @@ -1,5 +1,7 @@ --- title: stats +description: | + An aggregator for Pants stats, such as cache metrics. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/subprocess-environment.mdx b/versioned_docs/version-2.9/reference/subsystems/subprocess-environment.mdx index 10f6580b4..17ba0a093 100644 --- a/versioned_docs/version-2.9/reference/subsystems/subprocess-environment.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/subprocess-environment.mdx @@ -1,5 +1,7 @@ --- title: subprocess-environment +description: | + Environment settings for forked subprocesses. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/twine.mdx b/versioned_docs/version-2.9/reference/subsystems/twine.mdx index 0e84ccec4..9c7262eee 100644 --- a/versioned_docs/version-2.9/reference/subsystems/twine.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/twine.mdx @@ -1,5 +1,7 @@ --- title: twine +description: | + The utility for publishing Python distributions to PyPi and other Python repositories. --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/subsystems/yapf.mdx b/versioned_docs/version-2.9/reference/subsystems/yapf.mdx index 9dc3d5826..735861004 100644 --- a/versioned_docs/version-2.9/reference/subsystems/yapf.mdx +++ b/versioned_docs/version-2.9/reference/subsystems/yapf.mdx @@ -1,5 +1,7 @@ --- title: yapf +description: | + A formatter for Python files (https://github.com/google/yapf). --- import Option from "@site/src/components/reference/Option"; diff --git a/versioned_docs/version-2.9/reference/targets/archive.mdx b/versioned_docs/version-2.9/reference/targets/archive.mdx index 7933d0162..6c0fd92e2 100644 --- a/versioned_docs/version-2.9/reference/targets/archive.mdx +++ b/versioned_docs/version-2.9/reference/targets/archive.mdx @@ -1,5 +1,7 @@ --- title: archive +description: | + A ZIP or TAR file containing loose files and code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/deploy_jar.mdx b/versioned_docs/version-2.9/reference/targets/deploy_jar.mdx index 27fbb75a2..3eaecac8b 100644 --- a/versioned_docs/version-2.9/reference/targets/deploy_jar.mdx +++ b/versioned_docs/version-2.9/reference/targets/deploy_jar.mdx @@ -1,5 +1,7 @@ --- title: deploy_jar +description: | + A `jar` file with first and third-party code bundled for deploys. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/docker_image.mdx b/versioned_docs/version-2.9/reference/targets/docker_image.mdx index 5f49f19d3..f8a72ee14 100644 --- a/versioned_docs/version-2.9/reference/targets/docker_image.mdx +++ b/versioned_docs/version-2.9/reference/targets/docker_image.mdx @@ -1,5 +1,7 @@ --- title: docker_image +description: | + The `docker_image` target describes how to build and tag a Docker image. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/experimental_run_shell_command.mdx b/versioned_docs/version-2.9/reference/targets/experimental_run_shell_command.mdx index 37c49e850..2e7e16264 100644 --- a/versioned_docs/version-2.9/reference/targets/experimental_run_shell_command.mdx +++ b/versioned_docs/version-2.9/reference/targets/experimental_run_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_run_shell_command +description: | + Run a script in the workspace, with all dependencies packaged/copied into a chroot. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/experimental_shell_command.mdx b/versioned_docs/version-2.9/reference/targets/experimental_shell_command.mdx index 20aa1b562..205662c61 100644 --- a/versioned_docs/version-2.9/reference/targets/experimental_shell_command.mdx +++ b/versioned_docs/version-2.9/reference/targets/experimental_shell_command.mdx @@ -1,5 +1,7 @@ --- title: experimental_shell_command +description: | + Execute any external tool for its side effects. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/file.mdx b/versioned_docs/version-2.9/reference/targets/file.mdx index 722c35eb3..5ab6885ab 100644 --- a/versioned_docs/version-2.9/reference/targets/file.mdx +++ b/versioned_docs/version-2.9/reference/targets/file.mdx @@ -1,5 +1,7 @@ --- title: file +description: | + A single loose file that lives outside of code packages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/files.mdx b/versioned_docs/version-2.9/reference/targets/files.mdx index 30fd0de8c..f1ea07f45 100644 --- a/versioned_docs/version-2.9/reference/targets/files.mdx +++ b/versioned_docs/version-2.9/reference/targets/files.mdx @@ -1,5 +1,7 @@ --- title: files +description: | + Generate a `file` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/go_binary.mdx b/versioned_docs/version-2.9/reference/targets/go_binary.mdx index f7ba39d93..4ee700311 100644 --- a/versioned_docs/version-2.9/reference/targets/go_binary.mdx +++ b/versioned_docs/version-2.9/reference/targets/go_binary.mdx @@ -1,5 +1,7 @@ --- title: go_binary +description: | + A Go binary. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/go_mod.mdx b/versioned_docs/version-2.9/reference/targets/go_mod.mdx index 873bfaa82..32403b65b 100644 --- a/versioned_docs/version-2.9/reference/targets/go_mod.mdx +++ b/versioned_docs/version-2.9/reference/targets/go_mod.mdx @@ -1,5 +1,7 @@ --- title: go_mod +description: | + A first-party Go module (corresponding to a `go.mod` file). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/go_package.mdx b/versioned_docs/version-2.9/reference/targets/go_package.mdx index 5b7c662c9..4afd3ae03 100644 --- a/versioned_docs/version-2.9/reference/targets/go_package.mdx +++ b/versioned_docs/version-2.9/reference/targets/go_package.mdx @@ -1,5 +1,7 @@ --- title: go_package +description: | + A first-party Go package (corresponding to a directory with `.go` files). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/go_third_party_package.mdx b/versioned_docs/version-2.9/reference/targets/go_third_party_package.mdx index 312c8cb39..c7533c57d 100644 --- a/versioned_docs/version-2.9/reference/targets/go_third_party_package.mdx +++ b/versioned_docs/version-2.9/reference/targets/go_third_party_package.mdx @@ -1,5 +1,7 @@ --- title: go_third_party_package +description: | + A package from a third-party Go module. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/java_source.mdx b/versioned_docs/version-2.9/reference/targets/java_source.mdx index ee9559902..3dca16fc9 100644 --- a/versioned_docs/version-2.9/reference/targets/java_source.mdx +++ b/versioned_docs/version-2.9/reference/targets/java_source.mdx @@ -1,5 +1,7 @@ --- title: java_source +description: | + A single Java source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/java_sources.mdx b/versioned_docs/version-2.9/reference/targets/java_sources.mdx index ad6b1c1f8..f23710a91 100644 --- a/versioned_docs/version-2.9/reference/targets/java_sources.mdx +++ b/versioned_docs/version-2.9/reference/targets/java_sources.mdx @@ -1,5 +1,7 @@ --- title: java_sources +description: | + Generate a `java_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/junit_test.mdx b/versioned_docs/version-2.9/reference/targets/junit_test.mdx index 1e75cd8f6..1184703c9 100644 --- a/versioned_docs/version-2.9/reference/targets/junit_test.mdx +++ b/versioned_docs/version-2.9/reference/targets/junit_test.mdx @@ -1,5 +1,7 @@ --- title: junit_test +description: | + A single Java test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/junit_tests.mdx b/versioned_docs/version-2.9/reference/targets/junit_tests.mdx index 65b422627..d4b9a0f46 100644 --- a/versioned_docs/version-2.9/reference/targets/junit_tests.mdx +++ b/versioned_docs/version-2.9/reference/targets/junit_tests.mdx @@ -1,5 +1,7 @@ --- title: junit_tests +description: | + Generate a `junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.9/reference/targets/jvm_artifact.mdx index 42b6f56d1..0960442cd 100644 --- a/versioned_docs/version-2.9/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.9/reference/targets/jvm_artifact.mdx @@ -1,5 +1,7 @@ --- title: jvm_artifact +description: | + A third-party JVM artifact, as identified by its Maven-compatible coordinate. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.9/reference/targets/pants_requirements.mdx index 95e667d7d..9354b10d9 100644 --- a/versioned_docs/version-2.9/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.9/reference/targets/pants_requirements.mdx @@ -1,5 +1,7 @@ --- title: pants_requirements +description: | + Generate `python_requirement` targets for Pants itself to use with Pants plugins. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/pex_binary.mdx b/versioned_docs/version-2.9/reference/targets/pex_binary.mdx index 513cbfb39..4b97ec2e9 100644 --- a/versioned_docs/version-2.9/reference/targets/pex_binary.mdx +++ b/versioned_docs/version-2.9/reference/targets/pex_binary.mdx @@ -1,5 +1,7 @@ --- title: pex_binary +description: | + A Python target that can be converted into an executable PEX file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/protobuf_source.mdx b/versioned_docs/version-2.9/reference/targets/protobuf_source.mdx index 434a94ed3..6e0d6600c 100644 --- a/versioned_docs/version-2.9/reference/targets/protobuf_source.mdx +++ b/versioned_docs/version-2.9/reference/targets/protobuf_source.mdx @@ -1,5 +1,7 @@ --- title: protobuf_source +description: | + A single Protobuf file used to generate various languages. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/protobuf_sources.mdx b/versioned_docs/version-2.9/reference/targets/protobuf_sources.mdx index b89aabbbc..a44ec2bca 100644 --- a/versioned_docs/version-2.9/reference/targets/protobuf_sources.mdx +++ b/versioned_docs/version-2.9/reference/targets/protobuf_sources.mdx @@ -1,5 +1,7 @@ --- title: protobuf_sources +description: | + Generate a `protobuf_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/python_awslambda.mdx b/versioned_docs/version-2.9/reference/targets/python_awslambda.mdx index ccfe67f88..dcd60fed4 100644 --- a/versioned_docs/version-2.9/reference/targets/python_awslambda.mdx +++ b/versioned_docs/version-2.9/reference/targets/python_awslambda.mdx @@ -1,5 +1,7 @@ --- title: python_awslambda +description: | + A self-contained Python function suitable for uploading to AWS Lambda. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/python_distribution.mdx b/versioned_docs/version-2.9/reference/targets/python_distribution.mdx index d0e892374..eda14e797 100644 --- a/versioned_docs/version-2.9/reference/targets/python_distribution.mdx +++ b/versioned_docs/version-2.9/reference/targets/python_distribution.mdx @@ -1,5 +1,7 @@ --- title: python_distribution +description: | + A publishable Python setuptools distribution (e.g. an sdist or wheel). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/python_google_cloud_function.mdx b/versioned_docs/version-2.9/reference/targets/python_google_cloud_function.mdx index 385546a3d..13b550d06 100644 --- a/versioned_docs/version-2.9/reference/targets/python_google_cloud_function.mdx +++ b/versioned_docs/version-2.9/reference/targets/python_google_cloud_function.mdx @@ -1,5 +1,7 @@ --- title: python_google_cloud_function +description: | + A self-contained Python function suitable for uploading to Google Cloud Function. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/python_requirement.mdx b/versioned_docs/version-2.9/reference/targets/python_requirement.mdx index c40dd470b..cdbb61c1a 100644 --- a/versioned_docs/version-2.9/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.9/reference/targets/python_requirement.mdx @@ -1,5 +1,7 @@ --- title: python_requirement +description: | + A Python requirement installable by pip. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/python_source.mdx b/versioned_docs/version-2.9/reference/targets/python_source.mdx index 270b9478d..92bb71790 100644 --- a/versioned_docs/version-2.9/reference/targets/python_source.mdx +++ b/versioned_docs/version-2.9/reference/targets/python_source.mdx @@ -1,5 +1,7 @@ --- title: python_source +description: | + A single Python source file. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/python_sources.mdx b/versioned_docs/version-2.9/reference/targets/python_sources.mdx index 93d915923..adbb521f3 100644 --- a/versioned_docs/version-2.9/reference/targets/python_sources.mdx +++ b/versioned_docs/version-2.9/reference/targets/python_sources.mdx @@ -1,5 +1,7 @@ --- title: python_sources +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/python_test.mdx b/versioned_docs/version-2.9/reference/targets/python_test.mdx index e7147f47e..df8d20095 100644 --- a/versioned_docs/version-2.9/reference/targets/python_test.mdx +++ b/versioned_docs/version-2.9/reference/targets/python_test.mdx @@ -1,5 +1,7 @@ --- title: python_test +description: | + A single Python test file, written in either Pytest style or unittest style. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/python_test_utils.mdx b/versioned_docs/version-2.9/reference/targets/python_test_utils.mdx index 1f2da56cc..fee1a475e 100644 --- a/versioned_docs/version-2.9/reference/targets/python_test_utils.mdx +++ b/versioned_docs/version-2.9/reference/targets/python_test_utils.mdx @@ -1,5 +1,7 @@ --- title: python_test_utils +description: | + Generate a `python_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/python_tests.mdx b/versioned_docs/version-2.9/reference/targets/python_tests.mdx index cdd648d4b..11f7320ac 100644 --- a/versioned_docs/version-2.9/reference/targets/python_tests.mdx +++ b/versioned_docs/version-2.9/reference/targets/python_tests.mdx @@ -1,5 +1,7 @@ --- title: python_tests +description: | + Generate a `python_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/relocated_files.mdx b/versioned_docs/version-2.9/reference/targets/relocated_files.mdx index 44a0c8ff2..76471cbbb 100644 --- a/versioned_docs/version-2.9/reference/targets/relocated_files.mdx +++ b/versioned_docs/version-2.9/reference/targets/relocated_files.mdx @@ -1,5 +1,7 @@ --- title: relocated_files +description: | + Loose files with path manipulation applied. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/resource.mdx b/versioned_docs/version-2.9/reference/targets/resource.mdx index c405f89b6..e963f0bfe 100644 --- a/versioned_docs/version-2.9/reference/targets/resource.mdx +++ b/versioned_docs/version-2.9/reference/targets/resource.mdx @@ -1,5 +1,7 @@ --- title: resource +description: | + A single resource file embedded in a code package and accessed in a location-independent manner. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/resources.mdx b/versioned_docs/version-2.9/reference/targets/resources.mdx index 6016950df..5611db9f8 100644 --- a/versioned_docs/version-2.9/reference/targets/resources.mdx +++ b/versioned_docs/version-2.9/reference/targets/resources.mdx @@ -1,5 +1,7 @@ --- title: resources +description: | + Generate a `resource` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/scala_junit_test.mdx b/versioned_docs/version-2.9/reference/targets/scala_junit_test.mdx index c8cb27014..3e3800c4d 100644 --- a/versioned_docs/version-2.9/reference/targets/scala_junit_test.mdx +++ b/versioned_docs/version-2.9/reference/targets/scala_junit_test.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_test +description: | + A single Scala test, run with JUnit. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/scala_junit_tests.mdx b/versioned_docs/version-2.9/reference/targets/scala_junit_tests.mdx index 22f7ebd5f..58f067a0c 100644 --- a/versioned_docs/version-2.9/reference/targets/scala_junit_tests.mdx +++ b/versioned_docs/version-2.9/reference/targets/scala_junit_tests.mdx @@ -1,5 +1,7 @@ --- title: scala_junit_tests +description: | + Generate a `scala_junit_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/scala_source.mdx b/versioned_docs/version-2.9/reference/targets/scala_source.mdx index ad00f0e3a..625d26085 100644 --- a/versioned_docs/version-2.9/reference/targets/scala_source.mdx +++ b/versioned_docs/version-2.9/reference/targets/scala_source.mdx @@ -1,5 +1,7 @@ --- title: scala_source +description: | + A single Scala source file containing application or library code. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/scala_sources.mdx b/versioned_docs/version-2.9/reference/targets/scala_sources.mdx index cf5efe574..15bcd6158 100644 --- a/versioned_docs/version-2.9/reference/targets/scala_sources.mdx +++ b/versioned_docs/version-2.9/reference/targets/scala_sources.mdx @@ -1,5 +1,7 @@ --- title: scala_sources +description: | + Generate a `scala_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/scalac_plugin.mdx b/versioned_docs/version-2.9/reference/targets/scalac_plugin.mdx index 8e0594b2a..10a83af79 100644 --- a/versioned_docs/version-2.9/reference/targets/scalac_plugin.mdx +++ b/versioned_docs/version-2.9/reference/targets/scalac_plugin.mdx @@ -1,5 +1,7 @@ --- title: scalac_plugin +description: | + A plugin for `scalac`. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/scalatest_test.mdx b/versioned_docs/version-2.9/reference/targets/scalatest_test.mdx index b7e8762ad..fe03d1300 100644 --- a/versioned_docs/version-2.9/reference/targets/scalatest_test.mdx +++ b/versioned_docs/version-2.9/reference/targets/scalatest_test.mdx @@ -1,5 +1,7 @@ --- title: scalatest_test +description: | + A single Scala test, run with Scalatest. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/scalatest_tests.mdx b/versioned_docs/version-2.9/reference/targets/scalatest_tests.mdx index 755874616..22c031d01 100644 --- a/versioned_docs/version-2.9/reference/targets/scalatest_tests.mdx +++ b/versioned_docs/version-2.9/reference/targets/scalatest_tests.mdx @@ -1,5 +1,7 @@ --- title: scalatest_tests +description: | + Generate a `scalatest_test` target for each file in the `sources` field (defaults to all files in the directory matching ('*Spec.scala', '*Suite.scala')). --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/shell_source.mdx b/versioned_docs/version-2.9/reference/targets/shell_source.mdx index cd4f8669e..726a329a4 100644 --- a/versioned_docs/version-2.9/reference/targets/shell_source.mdx +++ b/versioned_docs/version-2.9/reference/targets/shell_source.mdx @@ -1,5 +1,7 @@ --- title: shell_source +description: | + A single Bourne-based shell script, e.g. a Bash script. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/shell_sources.mdx b/versioned_docs/version-2.9/reference/targets/shell_sources.mdx index f7997c969..5ff08e181 100644 --- a/versioned_docs/version-2.9/reference/targets/shell_sources.mdx +++ b/versioned_docs/version-2.9/reference/targets/shell_sources.mdx @@ -1,5 +1,7 @@ --- title: shell_sources +description: | + Generate a `shell_source` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/shunit2_test.mdx b/versioned_docs/version-2.9/reference/targets/shunit2_test.mdx index 6b7942756..2ac32738e 100644 --- a/versioned_docs/version-2.9/reference/targets/shunit2_test.mdx +++ b/versioned_docs/version-2.9/reference/targets/shunit2_test.mdx @@ -1,5 +1,7 @@ --- title: shunit2_test +description: | + A single test file for Bourne-based shell scripts using the shunit2 test framework. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/shunit2_tests.mdx b/versioned_docs/version-2.9/reference/targets/shunit2_tests.mdx index 292eff7c8..affb111ae 100644 --- a/versioned_docs/version-2.9/reference/targets/shunit2_tests.mdx +++ b/versioned_docs/version-2.9/reference/targets/shunit2_tests.mdx @@ -1,5 +1,7 @@ --- title: shunit2_tests +description: | + Generate a `shunit2_test` target for each file in the `sources` field. --- import Field from "@site/src/components/reference/Field"; diff --git a/versioned_docs/version-2.9/reference/targets/target.mdx b/versioned_docs/version-2.9/reference/targets/target.mdx index 86ddb5360..6cb0cbcd9 100644 --- a/versioned_docs/version-2.9/reference/targets/target.mdx +++ b/versioned_docs/version-2.9/reference/targets/target.mdx @@ -1,5 +1,7 @@ --- title: target +description: | + A generic target with no specific type. --- import Field from "@site/src/components/reference/Field";