Configuring authors¶
To configure authors, create a file named .authors.yml
in your project’s working directory. .authors.yml
should be valid YAML and contain five key-value pairs.
authors recognizes the following five keys.
name
: The name of the output file generated by authors.kind
: The format of the output file, whereadoc
,html
,md
,rst
, andtxt
are valid values.heading
: The heading string.opening
: The opening string.closing
: The closing string.
If authors cannot find .authors.yml
, or if it detects any missing or invalid values, then it will use the following default values.
name: AUTHORS
kind: md
heading: Authors
opening: Thank you to all of our contributors.
closing: This project would not be possible without you.