From 1de1a8cc00fa4f807574aaf6c197f858a20f28e1 Mon Sep 17 00:00:00 2001 From: linkfrg Date: Thu, 2 Jan 2025 14:14:02 +0000 Subject: [PATCH] deploy: 8536838849cb871e7e9bd5f8bf135e4bb4af77ed --- latest/_sources/dev/env.rst.txt | 70 ++++----------------------- latest/dev/env.html | 83 ++++----------------------------- latest/searchindex.js | 2 +- 3 files changed, 19 insertions(+), 136 deletions(-) diff --git a/latest/_sources/dev/env.rst.txt b/latest/_sources/dev/env.rst.txt index ae03c05c..833c2e10 100644 --- a/latest/_sources/dev/env.rst.txt +++ b/latest/_sources/dev/env.rst.txt @@ -1,74 +1,22 @@ Setting up a Development Environment ===================================== -Clone repository -------------------- +Firstly, clone the repository: .. code-block:: bash + # replace with the actual URL of your fork (if needed) git clone https://github.com/linkfrg/ignis.git cd ignis -Update submodules ------------------- +Then, run the script: .. code-block:: bash + + bash tools/setup_devenv.sh - git submodule update --init --recursive - -Create Python Virtual Environment ----------------------------------- - -.. code-block:: bash - - python -m venv venv - -Activate Virtual Environment ----------------------------- - -- For Bash: - -.. code-block:: bash - - source venv/bin/activate - -- For Fish: - -.. code-block:: fish - - . venv/bin/activate.fish - -Install dependencies to Virtual Environment -------------------------------------------- - -Common dependencies: - -.. code-block:: bash - - pip install --upgrade -r requirements.txt - -Development dependencies: - -.. code-block:: bash - - pip install --upgrade -r dev.txt - - -Build and Install Ignis to Virtual Environment ----------------------------------------------- - -.. code-block:: bash - - meson setup build --prefix=$(pwd)/venv --libdir "lib/ignis" - meson compile -C build - meson install -C build - -Make a symbolic link to Ignis sources -------------------------------------- - -Replace ``python3.12`` with actual version of python. +It will create a Python virtual environment, +install Ignis with its dependencies (including dev dependencies), and create a symbolic link to the Ignis source files. -.. code-block:: bash - - rm -R venv/lib/python3.12/site-packages/ignis - ln -sf $(pwd)/ignis venv/lib/python3.12/site-packages/ignis +Now you can edit the ``ignis`` directory at the root of the repository, +and the changes will be applied without the need to reinstall Ignis. diff --git a/latest/dev/env.html b/latest/dev/env.html index e194f73d..c78fa7f2 100644 --- a/latest/dev/env.html +++ b/latest/dev/env.html @@ -435,67 +435,20 @@

Setting up a Development Environment#

-
-

Clone repository#

-
git clone https://github.com/linkfrg/ignis.git
+

Firstly, clone the repository:

+
# replace with the actual URL of your fork (if needed)
+git clone https://github.com/linkfrg/ignis.git
 cd ignis
 
-
-
-

Update submodules#

-
git submodule update --init --recursive
-
-
-
-
-

Create Python Virtual Environment#

-
python -m venv venv
-
-
-
-
-

Activate Virtual Environment#

-
    -
  • For Bash:

  • -
-
source venv/bin/activate
-
-
-
    -
  • For Fish:

  • -
-
. venv/bin/activate.fish
+

Then, run the script:

+
bash tools/setup_devenv.sh
 
-
-
-

Install dependencies to Virtual Environment#

-

Common dependencies:

-
pip install --upgrade -r requirements.txt
-
-
-

Development dependencies:

-
pip install --upgrade -r dev.txt
-
-
-
-
-

Build and Install Ignis to Virtual Environment#

-
meson setup build --prefix=$(pwd)/venv --libdir "lib/ignis"
-meson compile -C build
-meson install -C build
-
-
-
- +

It will create a Python virtual environment, +install Ignis with its dependencies (including dev dependencies), and create a symbolic link to the Ignis source files.

+

Now you can edit the ignis directory at the root of the repository, +and the changes will be applied without the need to reinstall Ignis.

@@ -538,24 +491,6 @@

Make a symbolic link to Ignis sources -
- On this page -
-
- -