diff --git a/docs/source/conf.py b/docs/source/conf.py index 65dd978..869731b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,7 +19,7 @@ # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = ["sphinx.ext.mathjax"] +extensions = ["sphinx.ext.mathjax", "sphinx_inline_tabs"] templates_path = ["_templates"] exclude_patterns = [] diff --git a/docs/source/index.rst b/docs/source/index.rst index e791b18..9f5efb4 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -66,10 +66,27 @@ release, run the following:: $ cd code-base-investigator $ pip install . -We strongly recommend installing CBI within a `virtual environment`_. +We strongly recommend installing CBI within a virtual environment, to simplify +dependency management and improve security. Some alternative methods of +creating a virtual environment are shown below. -.. _`virtual environment`: https://docs.python.org/3/library/venv.html +.. tab:: venv + .. code-block:: text + + $ git clone --branch 1.2.0 https://github.com/intel/code-base-investigator.git + $ python3 -m venv cbi + $ source cbi/bin/activate + $ cd code-base-investigator + $ pip install . + +.. tab:: uv + + .. code-block:: text + + $ git clone --branch 1.2.0 https://github.com/intel/code-base-investigator.git + $ cd code-base-investigator + $ uv tool install . Getting Started ###############