diff --git a/docs/configuration.rst b/docs/configuration.rst index 99fe749..10d5719 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -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. @@ -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 ===============