Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
znichollscr committed Aug 5, 2024
1 parent a9c708b commit 8c03b86
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,10 @@ Top level keys

``""`` by default.

Formatted titles are appended a line of ``=`` on the following line (reStructuredText title format) unless the template has an ``.md`` suffix, in which case the title will instead be prefixed with ``#`` (markdown title format).
When using reStructuredText, formatted titles are underlined using the ``underlines`` configuration.
For titles, the first value from ``underlines`` is used to create the underline (which is inserted on the line following the title).
If the template has an ``.md`` suffix, we assume we are looking at markdown format and the title is applied as, i.e. full control over the title format is given to the user.
This choice is made because setting the correct markdown header level automatically is non-trivial (mainly because you don't know what context the generated CHANGELOG entries are being written into).

``issue_format``
A format string for rendering the issue/ticket number in newsfiles.
Expand Down

0 comments on commit 8c03b86

Please sign in to comment.