Skip to content

Commit

Permalink
docs(tutorial): Fix location of filename introduction
Browse files Browse the repository at this point in the history
Previously the `filename` option was only mentioned in the
Python-specific section
  • Loading branch information
infinisil committed Apr 15, 2024
1 parent 212a938 commit 4ecb59b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ The most basic configuration is just telling ``towncrier`` where to look for new

[tool.towncrier]
directory = "changes"
# Where you want your news files to come out. This can be .rst
# or .md, towncrier's default template works with both.
filename = "NEWS.rst"

Which will look into "./changes" for news fragments and write them into "./NEWS.rst".

Expand All @@ -32,9 +35,6 @@ If you're working on a Python project, you can also specify a package::
# but if you don't keep your code in a 'src' dir, remove the
# config option
package_dir = "src"
# Where you want your news files to come out. This can be .rst
# or .md, towncrier's default template works with both.
filename = "NEWS.rst"

By default, ``towncrier`` will look for news fragments inside your Python package, in a directory named ``newsfragments``.
With this example project, it will look in ``src/myproject/newsfragments/`` for them.
Expand Down

0 comments on commit 4ecb59b

Please sign in to comment.