Variable: rst-preferred-adornments

rst-preferred-adornments is a customizable variable defined in rst.el.gz.

Value

((61 over-and-under 1) (61 simple 0) (45 simple 0) (126 simple 0)
 (43 simple 0) (96 simple 0) (35 simple 0) (64 simple 0))

Documentation

Preferred hierarchy of section title adornments.

A list consisting of lists of the form (CHARACTER STYLE INDENT). CHARACTER is the character used. STYLE is one of the symbols over-and-under or simple. INDENT is an integer giving the wanted indentation for STYLE over-and-under.

This sequence is consulted to offer a new adornment suggestion when we rotate the underlines at the end of the existing hierarchy of characters, or when there is no existing section title in the file.

Set this to an empty list to use only the adornment found in the file.

Aliases

rst-preferred-decorations (obsolete since rst 1.0.0)

Source Code

;; Defined in /usr/src/emacs/lisp/textmodes/rst.el.gz
;; FIXME: Default must match suggestion in
;;        https://sphinx-doc.org/rest.html#sections for Python documentation.
(defcustom rst-preferred-adornments '((?= over-and-under 1)
				      (?= simple 0)
				      (?- simple 0)
				      (?~ simple 0)
				      (?+ simple 0)
				      (?` simple 0)
				      (?# simple 0)
				      (?@ simple 0))
  "Preferred hierarchy of section title adornments.
A list consisting of lists of the form (CHARACTER STYLE INDENT).
CHARACTER is the character used.  STYLE is one of the symbols
`over-and-under' or `simple'.  INDENT is an integer giving the
wanted indentation for STYLE `over-and-under'.

This sequence is consulted to offer a new adornment suggestion
when we rotate the underlines at the end of the existing
hierarchy of characters, or when there is no existing section
title in the file.

Set this to an empty list to use only the adornment found in the
file."
  :group 'rst-adjust
  :type `(repeat
	  (group :tag "Adornment specification"
		 (choice :tag "Adornment character"
                         ,@(mapcar (lambda (char)
                                     (list 'const
                                           :tag (char-to-string char) char))
				   rst-adornment-chars))
		 (radio :tag "Adornment type"
			(const :tag "Overline and underline" over-and-under)
			(const :tag "Underline only" simple))
		 (integer :tag "Indentation for overline and underline type"
			  :value 0))))