aboutsummaryrefslogtreecommitdiff
path: root/docs/py_cc_toolchain.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/py_cc_toolchain.md')
-rw-r--r--docs/py_cc_toolchain.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/py_cc_toolchain.md b/docs/py_cc_toolchain.md
new file mode 100644
index 0000000..3a59ea9
--- /dev/null
+++ b/docs/py_cc_toolchain.md
@@ -0,0 +1,32 @@
+<!-- Generated with Stardoc: http://skydoc.bazel.build -->
+
+Implementation of py_cc_toolchain rule.
+
+NOTE: This is a beta-quality feature. APIs subject to change until
+https://github.com/bazelbuild/rules_python/issues/824 is considered done.
+
+
+<a id="py_cc_toolchain"></a>
+
+## py_cc_toolchain
+
+<pre>
+py_cc_toolchain(<a href="#py_cc_toolchain-name">name</a>, <a href="#py_cc_toolchain-headers">headers</a>, <a href="#py_cc_toolchain-python_version">python_version</a>)
+</pre>
+
+A toolchain for a Python runtime's C/C++ information (e.g. headers)
+
+This rule carries information about the C/C++ side of a Python runtime, e.g.
+headers, shared libraries, etc.
+
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| <a id="py_cc_toolchain-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
+| <a id="py_cc_toolchain-headers"></a>headers | Target that provides the Python headers. Typically this is a cc_library target. | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
+| <a id="py_cc_toolchain-python_version"></a>python_version | The Major.minor Python version, e.g. 3.11 | String | required | |
+
+