cqrenet/relay
4
0
Fork 0
mirror of https://github.com/chatmail/relay.git synced 2026-05-19 12:28:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update documentation installation command from pip to uv.

Browse Source
This commit is contained in:
Omid Zamani
2026-01-02 16:38:25 +01:00
parent d089e7e06f
commit e6cdcc207a
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/README.md
View File

@@ -6,7 +6,7 @@ You can use the `make` command and `make html` to build web pages.
You need a Python environment where the following install was excuted: You need a Python environment where the following install was excuted:
pip install furo sphinx-autobuild uv pip install furo sphinx-autobuild
To develop/change documentation, you can then do: To develop/change documentation, you can then do:

6
doc/source/overview.rst
View File

@@ -15,11 +15,11 @@ has four main directories.
`scripts <https://github.com/chatmail/relay/tree/main/scripts>`_ `scripts <https://github.com/chatmail/relay/tree/main/scripts>`_
offers two convenience tools for beginners: offers two convenience tools for beginners:
- ``initenv.sh`` installs a local virtualenv Python environment and - ``initenv.sh`` installs a local Python environment using ``uv`` and
installs necessary dependencies installs necessary dependencies.
- ``scripts/cmdeploy`` script enables you to run the ``cmdeploy`` - ``scripts/cmdeploy`` script enables you to run the ``cmdeploy``
command line tool in the local Python virtual environment. command line tool using ``uv run``.
``cmdeploy/`` ``cmdeploy/``