openstack/kolla
Code Issues Proposed changes

Merge "[docs] remove not working dev setup"

Browse Source
This commit is contained in:
Zuul 2024-07-17 11:55:05 +00:00 committed by Gerrit Code Review
commit f63594bdc1
1 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/source/contributor/running-in-development.rst
View File

@ -7,23 +7,15 @@ Running Kolla Build in development
The recommended way to run in development
-----------------------------------------
The preferred way to run kolla-build for development is using ``tox``.
Run the following from inside the repository:
.. code-block:: console
tox -e venv -- kolla-build ...
The alternative way to run in development
-----------------------------------------
Sometimes, developers prefer to manage their venvs themselves. This is also
possible. Remember to install in editable mode (``-e``). Run the following from
inside the repository:
To clone the repository and install the package
in development mode, run the following commands:
.. code-block:: console
git clone https://opendev.org/openstack/kolla.git
cd kolla
python3 -m venv ~/path/to/venv
source ~/path/to/venv/bin/activate
python3 -m pip install -e .
python3 -m pip install --editable .
kolla-build ...