Skip to content

Commit

Permalink
docs: clarify the syntax of examples
Browse files Browse the repository at this point in the history
  • Loading branch information
Ned Batchelder committed Jul 19, 2023
1 parent fc2ee98 commit 6189354
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
Configuration
#############

.. highlight:: ini

Scriv tries hard to be adaptable to your project's needs. Many aspects of its
behavior can be customized with a settings file.

Expand Down Expand Up @@ -30,6 +32,20 @@ All of the possible files will be read, and settings will cascade. So for
example, setup.cfg can set the fragment directory to "scriv.d", then
"scriv.d/scriv.ini" will be read.

The settings examples here show .ini syntax. If you are using a pyproject.toml
file for settings, you will need to adjust for TOML syntax. This .ini
example::

[scriv]
version = literal: pyproject.toml: project.version

would become:

.. code-block:: toml
[tool.scriv]
version = "literal: pyproject.toml: project.version"
Settings Syntax
===============
Expand Down

0 comments on commit 6189354

Please sign in to comment.