From 960396c7fac5aec0381b8e00acf34975e3fdb1f4 Mon Sep 17 00:00:00 2001 From: aclist <92275929+aclist@users.noreply.github.com> Date: Sat, 7 Feb 2026 19:58:17 +0900 Subject: [PATCH] chore: add dev install isntructions to docs --- docs/source/conf.py | 6 +- docs/source/development.rst | 7 +++ docs/source/installation.rst | 110 +++++++++++++++++++++++++---------- 3 files changed, 88 insertions(+), 35 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 28a28fc..3ffa8d4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -30,11 +30,11 @@ extensions = [ "sphinx.ext.githubpages" ] html_theme = "sphinx_rtd_theme" -html_static_path = ['_static'] +#html_static_path = ['_static'] html_show_sphinx = False html_show_copyright = False html_show_sourcelink = False today_fmt = "%Y-%m-%d" -release = "5.8.x" -version = "5.8.x" +release = "6.x.x" +version = "6.x.x" diff --git a/docs/source/development.rst b/docs/source/development.rst index 879408b..5c6868c 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -10,3 +10,10 @@ file. All contributors are expected to act in accordance with the project's `code of conduct `_, and follow the project's standards and guidelines. + +To install DZGUI and related dependencies for linting, testing, and version control, +invoke the command ``uv pip install .[dev]``. + +After this process, install the applicable pre-commit hooks by invoking the command ``pre-commit install``. + +These pre-commit hooks enforce code checks that prevent making commits unless the relevant tests pass. diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 280e743..cb51ce8 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -1,8 +1,8 @@ Installation ================== -Dependencies ----------------------- +Basic runtime dependencies +--------------------------------- If not already installed, the below can be found in your system’s package manager. @@ -10,7 +10,6 @@ If any dependencies are missing when the application starts, it will warn you, s - curl - jq -- PyGObject (python-gobject) - steam - wmctrl or xdotool - zenity @@ -18,43 +17,90 @@ If any dependencies are missing when the application starts, it will warn you, s .. note:: All dependencies are installed out of the box on Steam Deck. -Downloading ------------------- +UI dependencies (Python and PyGObject) +--------------------------------------- +.. important:: + As of version 6.0.0, you must have a valid Python 3.13 and matching PyGObject environment. + Depending on your distribution, this may require additional manual intervention. -Automatic installation +Arch Linux (vanilla variants) +^^^^^^^^^^^^^^^^^^^^^^ +You will need the ``python3.13`` package, if it is not already installed. + +Install the following build dependencies: + +.. code:: console + + sudo pacman -S cmake gcc pkgconf python-cairo + +.. include:: venv.rst + +CachyOS (Arch) ^^^^^^^^^^^^^^^^^^^^^^^ -Invoke the command below from a terminal: +Refer to the build instructions for Arch Linux first. +The ``python3.13`` package is not available on CachyOS, so it is recommended to +use ``uv`` to manage Python versions. + +.. code:: console + + sudo pacman -S uv + +.. include:: venv.rst + +Manjaro 26 (Arch) +^^^^^^^^^^^^^^^^^^^^^^^ +If Python 3.13 is not already available out of the box, refer to the build instructions for :ref:`Arch Linux (vanilla variants)`. + +Debian 13 variants +^^^^^^^^^^^^^^^^^^^^^^^ +Python 3.13 and PyGObject are available out of the box. No additional steps are necessary. +You can proceed to the :ref:`Installscript`. + +Fedora 43 variants +^^^^^^^^^^^^^^^^^^^^^^^ +Fedora 43 ships with a newer version of Python (3.14), so you must set up Python 3.13 in its own +virtual environment (venv) to prevent it from conflicting with the system package. + +Install the following build dependencies: + +.. code:: console + + sudo dnf install cairo cairo-devel cairo-gobject-devel gcc python3.13 python3.13-devel + +.. include:: venv.rst + +Ubuntu 24 variants +^^^^^^^^^^^^^^^^^^^^^^ +Ubuntu ships with an older version of Python (3.12). You must install additional dependencies. +Add the PPA below to add Python 3.13 to your sources: + +.. code:: console + + sudo add-apt-repository ppa:deadsnakes/ppa + +Install the following build dependencies: + +.. code:: console + + sudo apt install python3.13 python3.13-venv python3.13-dev build-essential python3-gi-cairo pkg-config libgirepository-2.0-dev libcairo2-dev + +.. include:: venv.rst + +Installscript +----------------------- + +Invoke the command below from a terminal. This script fetches the main DZGUI script from the repository, +makes it executable, and launches DZGUI's first-time setup. After running this installscript, you will +have the file ``dzgui.sh`` wherever you invoked the command. .. code:: console curl -s "https://codeberg.org/aclist/dztui/raw/branch/dzgui/install.sh" | bash - -Manual installation -^^^^^^^^^^^^^^^^^^^^ - -Clone the repository: - -.. code:: console - - git clone https://codeberg.org/aclist/dztui.git - -Set the executable bit on ``dzgui.sh``: - -.. code:: console - - chmod +x dzgui.sh - - -Launch the script: - -.. code:: console - - ./dzgui.sh - nixOS installation -^^^^^^^^^^^^^^^^^^^ -Two packages are independently maintained by other contributors. Each takes a slightly different approach: +---------------------- +Two packages are independently maintained by other contributors. Each takes a slightly different approach. +nixOS packages are standalone and do not require cloning the git repository. - https://github.com/lelgenio/dzgui-nix - https://github.com/jiriks74/dzgui.flake