[format_rst]

RST formatting configuration

Guide: Formatting.

format_rst.blockquote_indent
Type:
integer
Default:
2

The number of spaces to use for indentation of blockquotes.

format_rst.definition_list_indent
Type:
integer
Default:
2

The number of spaces to use for indentation of definitions.

format_rst.directive_indent
Type:
integer
Default:
3

The number of spaces to use for indentation of directive content

format_rst.enum_list_auto
Type:
string
Default:
"preserve"

Behavior of enumerated lists when using auto # markers.

Values:

  • "preserve": Preserve # markers from the original text.

  • "always": Always use # markers for susequent items.

  • "never": Never use # markers for susequent items.

format_rst.enum_list_style
Type:
string
Default:
"preserve"

The style of enumerated list item markers.

Values:

  • "preserve": Preserve the original style of the list.

  • "period": Use a period after the number (e.g. 1., 2., 3.).

  • "rparen": Use a right parenthesis after the number (e.g. 1), 2), 3)).

  • "parens": Use parentheses around the number (e.g. (1), (2), (3)).

format_rst.fail_on_warning
Type:
array of strings
Default:
[]

A list of linting codes to fail formatting

format_rst.field_list_align_body
Type:
boolean
Default:
false

Whether to align the body of field lists with the with its first line.

format_rst.field_list_body_on_new_line
Type:
integer
Default:
20

The field length after which the first line of the body should start on a new line. 0 starts every body on a new line.

format_rst.field_list_indent
Type:
integer
Default:
2

The number of spaces to use for indentation of field bodies.

format_rst.literal_indent
Type:
integer
Default:
2

The number of spaces to use for indentation of literal blocks.

format_rst.paragraph_line_length
Type:
integer

A target width for paragraphs. Note this is not a hard limit, but a target length. It will also not wrap paragraphs in tables.

format_rst.paragraph_semantic_wrap
Type:
boolean
Default:
false

Whether to wrap paragraphs at semantic boundaries.

format_rst.simple_table_space
Type:
integer
Default:
2

The number of spaces to use between columns in simple tables.

format_rst.substitution_indent
Type:
integer
Default:
3

The number of spaces to use for indentation of substitution content.

format_rst.transition_char
Type:
string

The character to use for transition lines.

Values:

  • "-"

  • "="

  • "~"

  • "^"

  • "."

  • "+"

  • "_"

  • "#"

format_rst.transition_length
Type:
integer
Default:
10

The length of transition lines. At least 4: a shorter line of punctuation is not a transition.

format_rst.validate
Type:
boolean
Default:
true

Validate the formatted syntax structure has not changed.