diff --git a/docs/configuration.rst b/docs/configuration.rst index 9e5c2d6..09d241b 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -547,6 +547,13 @@ The ``[tool.versioningit.onbuild]`` Subtable .. versionadded:: 1.1.0 +.. attention:: + + Currently, the ``onbuild`` step is not supported when using + ``versioningit`` with Hatch. See `issue #54`__ for more information. + + __ https://github.com/jwodder/versioningit/issues/54 + The ``onbuild`` subtable configures an optional feature, inserting the project version and/or other fields into built project trees when building an sdist or wheel. Specifically, this feature allows you to create sdists & wheels in diff --git a/docs/hatch.rst b/docs/hatch.rst index f6386cd..63665f1 100644 --- a/docs/hatch.rst +++ b/docs/hatch.rst @@ -91,6 +91,13 @@ way as for setuptools: # `write` step: artifacts = ["src/mypackage/_version.py"] +.. attention:: + + Currently, :ref:`the onbuild step ` is not supported when using + ``versioningit`` with Hatch. See `issue #54`__ for more information. + + __ https://github.com/jwodder/versioningit/issues/54 + .. note:: If you use ``versioningit`` with Hatch, you will not be able to set your diff --git a/docs/runtime-version.rst b/docs/runtime-version.rst index 5c99317..a0ec9fd 100644 --- a/docs/runtime-version.rst +++ b/docs/runtime-version.rst @@ -93,6 +93,7 @@ usually also want to expose that version at runtime, usually via a Modifies working tree? [#f1]_ **Yes** **No** Requires configuration in ``setup.{py,cfg}``? **No** **Yes** Run when installing in editable mode? **Yes** **No** + Usable with Hatch? **Yes** **No** ============================================== ========= =========== .. [#f1] That is, the ``write`` method causes a file to be present (though