Pants v2: Fast, consistent builds for Python and more

Welcome to the Pants v2 documentation hub!

Pants v2 is a fast, scalable build system for growing codebases. It's currently focused on Python, with support for other languages coming soon.

Here you'll find guides to help you get started with Pants v2, comprehensive documentation on how to configure, run and customize Pants v2, and information on how to get help from the Pants community.

Get Started

docformatter

The Python docformatter tool (https://github.com/myint/docformatter).

Config section: [docformatter]

Basic options

--[no-]docformatter-skip
PANTS_DOCFORMATTER_SKIP
skip
default: False
Don't use docformatter when running `./pants fmt` and `./pants lint`.

--docformatter-args="[<shell_str>, <shell_str>, ...]"
PANTS_DOCFORMATTER_ARGS
args
default: []
Arguments to pass directly to docformatter, e.g. `--docformatter-args="--wrap-summaries=100 --pre-summary-newline"`.

Advanced options

--docformatter-version=<str>
PANTS_DOCFORMATTER_VERSION
version
default: docformatter>=1.3.1,<1.4
Requirement string for the tool.

--docformatter-extra-requirements="['<str>', '<str>', ...]"
PANTS_DOCFORMATTER_EXTRA_REQUIREMENTS
extra_requirements
default: []
Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.

--docformatter-entry-point=<str>
PANTS_DOCFORMATTER_ENTRY_POINT
entry_point
default: docformatter:main
The main module for the tool. If unspecified, the code using this tool must provide it explicitly on invocation, or it can use the tool as a library, invoked by a wrapper script.

--docformatter-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_DOCFORMATTER_INTERPRETER_CONSTRAINTS
interpreter_constraints
default:
[
  "CPython==2.7.*",
  "CPython>=3.4,<3.9"
]

Python interpreter constraints for this tool. An empty list uses the default interpreter constraints for the repo.

Deprecated options

None

Updated about a month ago


docformatter


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.