Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions for virtual environments #157

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = []
Expand Down
21 changes: 19 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
###############
Expand Down
Loading