From 2fa323248528604a3548fd1292c74c7b473c611b Mon Sep 17 00:00:00 2001 From: Josh Spicer Date: Mon, 13 Jun 2022 20:01:19 -0400 Subject: 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 --- src/python/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 src/python/README.md (limited to 'src/python') 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)._ -- cgit v1.2.3