aboutsummaryrefslogtreecommitdiff
path: root/src/python/README.md
diff options
context:
space:
mode:
authorJosh Spicer <joshspicer@github.com>2022-06-14 03:01:19 +0300
committerGitHub <noreply@github.com>2022-06-14 03:01:19 +0300
commit2fa323248528604a3548fd1292c74c7b473c611b (patch)
tree39831944b1ed879a3342310b6f2a107e48153aad /src/python/README.md
parentfac5e5a4540ffc79138b94ce8edfd329a209b250 (diff)
Devcontainer docs (#47)
* docs * automatically generate documentation from features.json * trigger doc gen * 1 * no-ci * no-ci * no-ci * no-ci * comment out pull * Automated documentation update * no-ci markdown table * Automated documentation update * no-ci * Automated documentation update * branch to main Co-authored-by: Devcontainers CI <vscr-feedback@microsoft.com>
Diffstat (limited to 'src/python/README.md')
-rw-r--r--src/python/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/python/README.md b/src/python/README.md
new file mode 100644
index 0000000..3af1ac8
--- /dev/null
+++ b/src/python/README.md
@@ -0,0 +1,33 @@
+
+# Python (may require compilation) (python)
+
+Python (may require compilation)
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/python@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select a Python version to install. | string | os-provided |
+| install_python_tools | Install common Python tools like pylint | boolean | true |
+| optimize | Optimize Python for performance when compiled (slow) | boolean | - |
+| installPath | The path where python will be installed. | string | /usr/local/python |
+| override_default_version | If true, overrides existing version (if any) of python on the PATH | boolean | true |
+| install_jupyterlab | Install JupyterLab, a web-based interactive development environment for notebooks | boolean | - |
+| configure_jupyterlab_allow_origin | Configure JupyterLab to accept HTTP requests from the specified origin | string | - |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._