Skip to content

Commit

Permalink
Fix formatting in README (#167)
Browse files Browse the repository at this point in the history
Thanks to @blueyed for this.
  • Loading branch information
blueyed authored and hawkowl committed Nov 26, 2019
1 parent 3d01a19 commit fff788d
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 16 deletions.
37 changes: 21 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,21 @@ Install from PyPI::

In your project root, add a ``pyproject.toml`` file.
You can configure your project in two ways.
To configure it via an explicit directory, add::
To configure it via an explicit directory, add:

.. code-block:: ini
[tool.towncrier]
directory = "changes"
directory = "changes"
Alternatively, to configure it relative to a (Python) package directory, add::
Alternatively, to configure it relative to a (Python) package directory, add:

.. code-block:: ini
[tool.towncrier]
package = "mypackage"
package_dir = "src"
filename = "NEWS.rst"
package = "mypackage"
package_dir = "src"
filename = "NEWS.rst"
For the latter, news fragments (see "News Fragments" below) should be in a ``newsfragments`` directory under your package.
Using the above example, your news fragments would be ``src/myproject/newsfragments/``).
Expand Down Expand Up @@ -112,8 +115,9 @@ Further Options

Towncrier has the following global options, which can be specified in the toml file:

```
[tool.towncrier]
.. code-block:: ini
[tool.towncrier]
package = ""
package_dir = "."
single_file = true # if false, filename is formatted like `title_format`.
Expand All @@ -126,14 +130,15 @@ Towncrier has the following global options, which can be specified in the toml f
underlines: "=-~"
wrap = false # Wrap text to 79 characters
all_bullets = true # make all fragments bullet points
```
If a single file is used, the content of this file are overwritten each time.
If a single file is used, the content of that file gets overwritten each time.

Furthermore, you can add your own fragment types using:
```
[tool.towncrier]

.. code-block:: ini
[tool.towncrier]
[[tool.towncrier.type]]
directory = "deprecation"
name = "Deprecations"
showcontent = true
```
directory = "deprecation"
name = "Deprecations"
showcontent = true
1 change: 1 addition & 0 deletions src/towncrier/newsfragments/167.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

0 comments on commit fff788d

Please sign in to comment.