Skip to content

Commit

Permalink
Document the option to name the configuration file towncrier.toml (#172)
Browse files Browse the repository at this point in the history
* Document the option to name the configuration file towncrier.toml

Remove obsolete reference to towncrier.ini.

* Update README.rst

Co-authored-by: Kyle Altendorf <sda@fstab.net>
  • Loading branch information
tjanez and altendky authored Dec 7, 2020
1 parent 441ef3f commit 2c6caa8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Install from PyPI::
It is usable by projects written in other languages, provided you specify the project version either in the configuration file or on the command line.
For Python 2/3 compatible projects, the version can be discovered automatically.

In your project root, add a ``pyproject.toml`` file.
In your project root, add a ``towncrier.toml`` or a ``pyproject.toml`` file (if both files exist, the first will take precedence).
You can configure your project in two ways.
To configure it via an explicit directory, add:

Expand Down Expand Up @@ -92,7 +92,7 @@ To produce the news file for real, run::

towncrier build

This command will remove the news files (with ``git rm``) and append the built news to the filename specified in ``towncrier.ini``, and then stage the news file changes (with ``git add``).
This command will remove the news files (with ``git rm``) and append the built news to the filename specified by the ``filename`` configuration option, and then stage the news file changes (with ``git add``).
It leaves committing the changes up to the user.

If you wish to have content at the top of the news file (for example, to say where you can find the tickets), put your text above a rST comment that says::
Expand Down
2 changes: 2 additions & 0 deletions src/towncrier/newsfragments/172.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The README now mentions the possibility to name the configuration file
``towncrier.toml`` (in addition to ``pyproject.toml``).

0 comments on commit 2c6caa8

Please sign in to comment.