Skip to content

Commit

Permalink
Add documentation for free-threading flag
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholasjng committed Oct 23, 2024
1 parent 157cacd commit 7015ccd
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/api_bazel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,3 +155,15 @@ following flag settings.
version. Allowed values are ``"cp312"``, ``"cp313"``, which target the
stable ABI starting from Python 3.12 or 3.13, respectively. By default, all
extensions are built without any ABI limitations.

.. py:function:: @nanobind_bazel//:free_threading (boolean)
Build nanobind extensions with a Python toolchain in free-threaded mode.
If given, the currently configured Python toolchain must support free-threading,
otherwise, the build will result in a compilation error.
Only relevant for CPython 3.13+, since support for free-threaded Python was
introduced in CPython 3.13.
For more information on free-threaded extension support in nanobind, refer to the
relevant :ref:`documentation section <free-threaded>`.

*New in nanobind-bazel version 2.2.0.*

0 comments on commit 7015ccd

Please sign in to comment.