Skip to content

Commit

Permalink
Rework Install docs
Browse files Browse the repository at this point in the history
Include the requirement files directly to not duplicate the information
  • Loading branch information
florianfesti committed May 15, 2024
1 parent 6a6a1ee commit 387beee
Showing 1 changed file with 15 additions and 22 deletions.
37 changes: 15 additions & 22 deletions documentation/src/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
......
Expand Down

0 comments on commit 387beee

Please sign in to comment.