From 387beee9dbda798b3bd61159356bff6be28e7345 Mon Sep 17 00:00:00 2001 From: Florian Festi Date: Wed, 15 May 2024 22:11:57 +0200 Subject: [PATCH] Rework Install docs Include the requirement files directly to not duplicate the information --- documentation/src/install.rst | 37 ++++++++++++++--------------------- 1 file changed, 15 insertions(+), 22 deletions(-) diff --git a/documentation/src/install.rst b/documentation/src/install.rst index 6966fad9e..6d975879e 100644 --- a/documentation/src/install.rst +++ b/documentation/src/install.rst @@ -9,42 +9,35 @@ installing or building binary formats. Requirements ------------ -Affine -........ -:code:`Affine` (package name may be :code:`python-affine` or -:code:`python3-affine`) is used for vector calculation. - -Shapely -....... -:code:`shapely` (package name may be :code:`python-shapely` or -:code:`python3-shapely`) is used for filling shapes (with holes). +Python +...... +Boxes.py is implemented in Python 3. For supported minor version see :code:`setup.py`. -Markdown -........ -:code:`Markdown` (package name may be :code:`python-markdown` or -:code:`python3-markdown`) is used to format the description texts. +Python modules +.............. +Boxes.py need a set of Python modules: -setuptools -.......... +.. include:: ../../requirements.txt -Setup.py uses the :code:`setuptools` library (package name may be -:code:`python*-setuptools`). You only need it if you want to build the -package. +When using a distribution the packages will typically be name be :code:`python-MODULE` or :code:`python3-MODULE` pstoedit ........ While not a hard requirement Boxes.py uses :code:`pstoedit` (sometimes :code:`ps2edit`) to offer formats -that are not supported by Cairo: DXF, gcode, PLT. Currently the location +that are not supported by directly by the graphics backend: DXF, gcode, PLT. Currently the location Boxes.py looks for :code:`pstoedit` is hard coded to :code:`/usr/bin/pstoedit` in the :code:`boxes.formats.Formats` class. -Python -...... +Python modules for development +.............................. + +For development (e.g. running the test suite and generating the documentation) the following modules are also needed: + +.. include:: ../../requirements_dev.txt -Boxes.py is implemented in Python 3. For supported minor version see :code:`setup.py`. Sphinx ......