Docs for the provided distutils commands

This commit is contained in:
Davide Andreoli 2015-01-06 18:43:31 +01:00
parent f91999ac49
commit 24d4e16cfa
1 changed files with 58 additions and 0 deletions

View File

@ -5,6 +5,7 @@
.. versionadded:: 1.8
@ -36,6 +37,7 @@ And you may control the child loggers individually::
.. versionadded:: 1.8
Class properties
@ -51,3 +53,59 @@ are not already used by the constructor, for example like this::
.. versionadded:: 1.8
Using keyword arguments to set properties
Distutils helpers for your
.. versionadded:: 1.13
For your convenience **python-efl** provide some usefull `distutils
<>`_ Commands to be used in your
**** script.
Provided commands are:
* ``build_edc`` To build (using edje_cc) and install your application themes.
* ``build_i18n`` To integrate the gettext framework.
* ``build_fdo`` To install .desktop and icons as per FreeDesktop specifications.
* ``uninstall`` To uninstall your app.
* ``build_extra`` Adds the provided commands to the build target.
The usage is quite simple, just import and add them in your setup() cmdclass.
.. code-block:: python
from distutils.core import setup
from efl.utils.setup import build_edc, build_i18n, build_fdo
from efl.utils.setup import build_extra, uninstall
cmdclass = {
'build': build_extra,
'build_edc': build_edc,
'build_i18n': build_i18n,
'build_fdo': build_fdo,
'uninstall': uninstall,
'install': {'record': ('', 'installed_files.txt')}
The **install** option is required if you want to use the **uninstall** command.
The **build_extra** command is only used to automatically add all the other
commands to the default build command, you probably always want it, unless
you are providing your own yet.
Once you have added a command you can look at the help for more informations,
for example::
python build_i18n --help
or more in general::
python --help-commands