Skip to content

Commit 6731a1c

Browse files
author
Matthias Koeppe
committed
src/doc/en/developer/packaging.rst: Unify indentation in Sphinx list
1 parent 6e0d890 commit 6731a1c

File tree

1 file changed

+57
-57
lines changed

1 file changed

+57
-57
lines changed

src/doc/en/developer/packaging.rst

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -424,70 +424,70 @@ begin with ``sdh_``, which stands for "Sage-distribution helper".
424424
the given arguments, as well as additional default arguments used for
425425
installing packages into Sage.
426426
427-
- ``sdh_pip_install [...]``: The equivalent of running ``pip install``
428-
with the given arguments, as well as additional default arguments used for
429-
installing packages into Sage with pip. The last argument must be
430-
``.`` to indicate installation from the current directory.
431-
432-
``sdh_pip_install`` actually does the installation via ``pip wheel``,
433-
creating a wheel file in ``dist/``, followed by
434-
``sdh_store_and_pip_install_wheel`` (see below).
435-
436-
- ``sdh_pip_editable_install [...]``: The equivalent of running ``pip install -e``
437-
with the given arguments, as well as additional default arguments used for
438-
installing packages into Sage with pip. The last argument must be
439-
``.`` to indicate installation from the current directory.
440-
See `pip documentation <https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs>`_
441-
for more details concerning editable installs.
442-
443-
- ``sdh_pip_uninstall [...]``: Runs ``pip uninstall`` with the given arguments.
444-
If unsuccessful, it displays a warning.
445-
446-
- ``sdh_store_and_pip_install_wheel .``: The current directory,
447-
indicated by the required argument ``.``, must have a subdirectory
448-
``dist`` containing a unique wheel file (``*.whl``).
449-
450-
This command (1) moves this wheel file to the
451-
directory ``$SAGE_SPKG_WHEELS`` (``$SAGE_LOCAL/var/lib/sage/wheels``)
452-
and then (2) installs the wheel in ``$SAGE_LOCAL``.
453-
454-
Both of these steps, instead of writing directly into ``$SAGE_LOCAL``,
455-
use the staging directory ``$SAGE_DESTDIR`` if set; otherwise, they
456-
use ``$SAGE_SUDO`` (if set).
457-
458-
- ``sdh_install [-T] SRC [SRC...] DEST``: Copies one or more files or
459-
directories given as ``SRC`` (recursively in the case of
460-
directories) into the destination directory ``DEST``, while
461-
ensuring that ``DEST`` and all its parent directories exist.
462-
``DEST`` should be a path under ``$SAGE_LOCAL``, generally. For
463-
``DESTDIR`` installs, the ``$SAGE_DESTDIR`` path is automatically
464-
prepended to the destination.
465-
466-
The ``-T`` option treats ``DEST`` as a normal file instead
467-
(e.g. for copying a file to a different filename). All directory
468-
components are still created in this case.
427+
- ``sdh_pip_install [...]``: The equivalent of running ``pip install``
428+
with the given arguments, as well as additional default arguments used for
429+
installing packages into Sage with pip. The last argument must be
430+
``.`` to indicate installation from the current directory.
431+
432+
``sdh_pip_install`` actually does the installation via ``pip wheel``,
433+
creating a wheel file in ``dist/``, followed by
434+
``sdh_store_and_pip_install_wheel`` (see below).
435+
436+
- ``sdh_pip_editable_install [...]``: The equivalent of running ``pip install -e``
437+
with the given arguments, as well as additional default arguments used for
438+
installing packages into Sage with pip. The last argument must be
439+
``.`` to indicate installation from the current directory.
440+
See `pip documentation <https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs>`_
441+
for more details concerning editable installs.
442+
443+
- ``sdh_pip_uninstall [...]``: Runs ``pip uninstall`` with the given arguments.
444+
If unsuccessful, it displays a warning.
445+
446+
- ``sdh_store_and_pip_install_wheel .``: The current directory,
447+
indicated by the required argument ``.``, must have a subdirectory
448+
``dist`` containing a unique wheel file (``*.whl``).
449+
450+
This command (1) moves this wheel file to the
451+
directory ``$SAGE_SPKG_WHEELS`` (``$SAGE_LOCAL/var/lib/sage/wheels``)
452+
and then (2) installs the wheel in ``$SAGE_LOCAL``.
453+
454+
Both of these steps, instead of writing directly into ``$SAGE_LOCAL``,
455+
use the staging directory ``$SAGE_DESTDIR`` if set; otherwise, they
456+
use ``$SAGE_SUDO`` (if set).
457+
458+
- ``sdh_install [-T] SRC [SRC...] DEST``: Copies one or more files or
459+
directories given as ``SRC`` (recursively in the case of
460+
directories) into the destination directory ``DEST``, while
461+
ensuring that ``DEST`` and all its parent directories exist.
462+
``DEST`` should be a path under ``$SAGE_LOCAL``, generally. For
463+
``DESTDIR`` installs, the ``$SAGE_DESTDIR`` path is automatically
464+
prepended to the destination.
465+
466+
The ``-T`` option treats ``DEST`` as a normal file instead
467+
(e.g. for copying a file to a different filename). All directory
468+
components are still created in this case.
469469
470470
The following is automatically added to each install script, so you
471471
should not need to add it yourself.
472472
473-
- ``sdh_guard``: Wrapper for ``sdh_check_vars`` that checks some
474-
common variables without which many/most packages won't build
475-
correctly (``SAGE_ROOT``, ``SAGE_LOCAL``, ``SAGE_SHARE``). This is
476-
important to prevent installation to unintended locations.
473+
- ``sdh_guard``: Wrapper for ``sdh_check_vars`` that checks some
474+
common variables without which many/most packages won't build
475+
correctly (``SAGE_ROOT``, ``SAGE_LOCAL``, ``SAGE_SHARE``). This is
476+
important to prevent installation to unintended locations.
477477
478478
The following are also available, but rarely used.
479479
480-
- ``sdh_cmake [...]``: Runs ``cmake`` in the current directory with
481-
the given arguments, as well as additional arguments passed to
482-
cmake (assuming packages are using the GNUInstallDirs module) so
483-
that ``CMAKE_INSTALL_PREFIX`` and ``CMAKE_INSTALL_LIBDIR`` are set
484-
correctly.
485-
486-
- ``sdh_preload_lib EXECUTABLE SONAME``: (Linux only -- no-op on other
487-
platforms.) Check shared libraries loaded by ``EXECUTABLE`` (may be a
488-
program or another library) for a library starting with ``SONAME``, and
489-
if found appends ``SONAME`` to the ``LD_PRELOAD`` environment variable.
490-
See :trac:`24885`.
480+
- ``sdh_cmake [...]``: Runs ``cmake`` in the current directory with
481+
the given arguments, as well as additional arguments passed to
482+
cmake (assuming packages are using the GNUInstallDirs module) so
483+
that ``CMAKE_INSTALL_PREFIX`` and ``CMAKE_INSTALL_LIBDIR`` are set
484+
correctly.
485+
486+
- ``sdh_preload_lib EXECUTABLE SONAME``: (Linux only -- no-op on other
487+
platforms.) Check shared libraries loaded by ``EXECUTABLE`` (may be a
488+
program or another library) for a library starting with ``SONAME``, and
489+
if found appends ``SONAME`` to the ``LD_PRELOAD`` environment variable.
490+
See :trac:`24885`.
491491
492492
493493
.. _spkg-configure.m4:

0 commit comments

Comments
 (0)